NotBlank
NotBlank¶
Validates that a value is not blank, defined as not strictly false
,
not equal to a blank string and also not equal to null
. To force that
a value is simply not equal to null
, see the
NotNull constraint.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\NotBlank |
Validator | Symfony\Component\Validator\Constraints\NotBlankValidator |
Basic Usage¶
If you wanted to ensure that the firstName
property of an Author
class were not blank, you could do the following:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Author.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Author { /** * @Assert\NotBlank() */ protected $firstName; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Author: properties: firstName: - NotBlank: ~
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- src/AppBundle/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="AppBundle\Entity\Author"> <property name="firstName"> <constraint name="NotBlank" /> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// src/AppBundle/Entity/Author.php namespace AppBundle\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\NotBlank()); } }
Options¶
message¶
type: string
default: This value should not be blank.
This is the message that will be shown if the value is blank.
payload¶
type: mixed
default: null
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.