IsTrue
Edit this pageWarning: You are browsing the documentation for Symfony 3.2, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
IsTrue
Validates that a value is true. Specifically, this checks to see if
the value is exactly true, exactly the integer 1, or exactly the
string "1".
Also see IsFalse.
| Applies to | property or method |
| Options | |
| Class | True |
| Validator | TrueValidator |
Basic Usage
This constraint can be applied to properties (e.g. a termsAccepted property
on a registration model) or to a "getter" method. It's most powerful in
the latter case, where you can assert that a method returns a true value.
For example, suppose you have the following method:
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
class Author
{
protected $token;
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}Then you can constrain this method with IsTrue.
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/AppBundle/Entity/Author.php
namespace AppBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
protected $token;
/**
* @Assert\IsTrue(message = "The token is invalid")
*/
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}If the isTokenValid() returns false, the validation will fail.
Options
message
type: string default: This value should be true.
This message is shown if the underlying data is not true.
payload
type: mixed default: null
This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.
For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.
