You are browsing the documentation for Symfony 2.6 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
False
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;
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/Acme/BlogBundle/Entity/Author.php namespace Acme\BlogBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\False( * message = "You've entered an invalid state." * ) */ public function isStateInvalid() { // ... } }
- YAML
1 2 3 4 5 6
# src/Acme/BlogBundle/Resources/config/validation.yml Acme\BlogBundle\Entity\Author getters: stateInvalid: - 'False': message: You've entered an invalid state.
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- src/Acme/BlogBundle/Resources/config/validation.xml --> <?xml version="1.0" encoding="UTF-8" ?> <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd"> <class name="Acme\BlogBundle\Entity\Author"> <getter property="stateInvalid"> <constraint name="False"> <option name="message">You've entered an invalid state.</option> </constraint> </getter> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// src/Acme/BlogBundle/Entity/Author.php namespace Acme\BlogBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Author { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addGetterConstraint('stateInvalid', new Assert\False()); } }
Caution
When using YAML, be sure to surround False
with quotes ('False'
)
or else YAML will convert this into a false
boolean value.
Options¶
message¶
type: string
default: This value should be false.
This message is shown if the underlying data is not false.
payload¶
type: mixed
default: null
New in version 2.6: The payload
option was introduced in Symfony 2.6.
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.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.