IsNull
Warning: You are browsing the documentation for Symfony 2.x, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
Validates that a value is exactly equal to null
. To force that a property
is simply blank (blank string or null
), see the Blank
constraint. To ensure that a property is not null, see NotNull.
Also see NotNull.
Applies to | property or method |
Options | |
Class | IsNull |
Validator | IsNullValidator |
Basic Usage
If, for some reason, you wanted to ensure that the firstName
property
of an Author
class exactly equal to null
, 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\IsNull
*/
protected $firstName;
}
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Author:
properties:
firstName:
- 'IsNull': ~
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="IsNull" />
</property>
</class>
</constraint-mapping>
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', Assert\IsNull());
}
}
Options
message
type: string
default: This value should be null.
This is the message that will be shown if the value is not null
.
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.