Blank
Edit this pageWarning: You are browsing the documentation for Symfony 2.8, which is no longer maintained.
Read the updated version of this page for Symfony 6.0 (the current stable version).
Blank
Validates that a value is blank - meaning equal to an empty string or null:
1 2 3
if ('' !== $value && null !== $value) {
// validation will fail
}To force that a value strictly be equal to null, see the
IsNull constraint.
To force that a value is not blank, see NotBlank.
But be careful as NotBlank is not strictly the opposite of Blank.
| Applies to | property or method |
| Options | |
| Class | Blank |
| Validator | 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
- YAML
- XML
- PHP
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\Blank
*/
protected $firstName;
}Options
message
type: string default: This value should be blank.
This is the message that will be shown if the value is not blank.
You can use the following parameters in this message:
| Parameter | Description |
|---|---|
{{ value }} |
The current (invalid) value |
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.
