1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. IsNull

You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

IsNull

4.1 version
Maintained
2.8 3.4 4.2 master
Unmaintained
2.3 2.7 3.0 3.1 3.2 3.3 4.0
edit this page

IsNull

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:

  • Annotations
     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\IsNull()
     */
    protected $firstName;
}
  • YAML
    1
2
3
4
5
    # config/validator/validation.yaml
App\Entity\Author:
    properties:
        firstName:
            - 'IsNull': ~
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- config/validator/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="App\Entity\Author">
        <property name="firstName">
            <constraint name="IsNull" />
        </property>
    </class>
</constraint-mapping>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Entity/Author.php
namespace App\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.

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.