False¶
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 True.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\False |
Validator | Symfony\Component\Validator\Constraints\FalseValidator |
Basic Usage¶
The False
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:
protected $state;
protectd $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:
- YAML
# src/BlogBundle/Resources/config/validation.yml Acme\BlogBundle\Entity\Author getters: stateInvalid: - "False": message: You've entered an invalid state.
- Annotations
// src/Acme/BlogBundle/Entity/Author.php use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\False() */ public function isStateInvalid($message = "You've entered an invalid state.") { // ... } }
Caution
When using YAML, be sure to surround False
with quotes ("False"
)
or else YAML will convert this into a Boolean value.