NotBlank
Edit this pageWarning: You are browsing the documentation for Symfony 3.2, which is no longer maintained.
Read the updated version of this page for Symfony 6.3 (the current stable version).
NotBlank
Validates that a value is not blank - meaning not equal to a blank string,
a blank array or null:
1 2 3
if (false === $value || (empty($value) && '0' != $value)) {
// validation will fail
}To force that a value is simply not equal to null, see the
NotNull constraint.
| Applies to | property or method |
| Options | |
| Class | NotBlank |
| Validator | NotBlankValidator |
Basic Usage
If you wanted to ensure that the firstName property of an Author
class were not blank, you could do the following:
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;
}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.
