SymfonyWorld Online 2021 Summer Edition
June 17 – 18, 2021
SymfonyWorld Online 2021 Winter Edition
December 9 – 10, 2021
  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. NotNull

Warning: You are browsing the documentation for Symfony 2.5, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

NotNull

2.5 version
Maintained
4.4 5.3 current 5.4 dev 6.0
Unmaintained
2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

NotNull

Validates that a value is not strictly equal to null. To ensure that a value is simply not blank (not a blank string), see the NotBlank constraint.

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\NotNull
Validator Symfony\Component\Validator\Constraints\NotNullValidator

Basic Usage

If you wanted to ensure that the firstName property of an Author class were not strictly equal to null, you would:

  • YAML
    1
2
3
4
5
    # src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
    properties:
        firstName:
            - NotNull: ~
  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\NotNull()
     */
    protected $firstName;
}
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- src/Acme/BlogBundle/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="Acme\BlogBundle\Entity\Author">
        <property name="firstName">
            <constraint name="NotNull" />
        </property>
    </class>
</constraint-mapping>
  • PHP
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\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', new Assert\NotNull());
    }
}

Options

message

type: string default: This value should not be null.

This is the message that will be shown if the value is null.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.