NotBlank
Edit this pageWarning: You are browsing the documentation for Symfony 4.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
NotBlank
Validates that a value is not blank - meaning not equal to a blank string,
a blank array, false or null (null behavior is configurable). To check
that a value is 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:
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Entity/Author.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\NotBlank
*/
protected $firstName;
}Options
allowNull
type: bool default: false
If set to true, null values are considered valid and won't trigger a
constraint violation.
4.3
The allowNull option was introduced in Symfony 4.3.
groups
type: array | string
It defines the validation group or groups this constraint belongs to. Read more about validation groups.
message
type: string default: This value should not be blank.
This is the message that will be shown if the value is blank.
You can use the following parameters in this message:
| Parameter | Description |
|---|---|
{{ value }} |
The current (invalid) value |
normalizer
type: a PHP callable default: null
This option allows to define the PHP callable applied to the given value before checking if it is valid.
For example, you may want to pass the 'trim' string to apply the
trim PHP function in order to ignore leading and trailing
whitespace during validation.
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.
