True
Edit this pageWarning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.
Consider upgrading your projects to Symfony 6.2.
True
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 False.
| 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/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
class Author
{
protected $token;
public function isTokenValid()
{
return $this->token == $this->generateToken();
}
}Then you can constrain this method with True.
- YAML
- Annotations
- XML
- PHP
1 2 3 4 5
# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
getters:
tokenValid:
- 'True': { message: "The token is invalid." }If the isTokenValid() returns false, the validation will fail.
Caution
When using YAML, be sure to surround True with quotes ('True')
or else YAML will convert this into a true Boolean value.
