You are browsing the documentation for Symfony 2.6 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
Blank
Blank¶
Validates that a value is blank, defined as equal to a blank string or equal
to null
. To force that a value strictly be equal to null
, see the
Null constraint. To force that a value is
not blank, see NotBlank.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\Blank |
Validator | Symfony\Component\Validator\Constraints\BlankValidator |
Basic Usage¶
If, for some reason, you wanted to ensure that the firstName
property
of an Author
class were blank, you could do the following:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/BlogBundle/Entity/Author.php namespace Acme\BlogBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\Blank() */ protected $firstName; }
- YAML
1 2 3 4 5
# src/Acme/BlogBundle/Resources/config/validation.yml Acme\BlogBundle\Entity\Author: properties: firstName: - Blank: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- 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"> <property name="firstName"> <constraint name="Blank" /> </property> </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->addPropertyConstraint('firstName', new Assert\Blank()); } }
Options¶
message¶
type: string
default: This value should be blank.
This is the message that will be shown if the value is not blank.
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.