Warning: You are browsing the documentation for Symfony 2.3, which is no longer maintained.
Read the updated version of this page for Symfony 5.3 (the current stable version).
IsFalse
Validates that a value is false. Specifically, this checks to see if
the value is exactly false, exactly the integer 0, or exactly the
string "0".
Also see IsTrue.
| Applies to | property or method |
| Options | |
| Class | IsFalse |
| Validator | IsFalseValidator |
Basic Usage
The IsFalse constraint can be applied to a property or a "getter" method,
but is most commonly useful in the latter case. For example, suppose that
you want to guarantee that some state property is not in a dynamic
invalidStates array. First, you'd create a "getter" method:
1 2 3 4 5 6 7 8
protected $state;
protected $invalidStates = array();
public function isStateInvalid()
{
return in_array($this->state, $this->invalidStates);
}In this case, the underlying object is only valid if the isStateInvalid
method returns false:
- 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
{
/**
* @Assert\IsFalse(
* message = "You've entered an invalid state."
* )
*/
public function isStateInvalid()
{
// ...
}
}