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

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

NotBlank

2.1 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

NotBlank
- Basic Usage
- Options
  - message

NotBlank¶

Validates that a value is not blank, defined as not equal to a blank string and also not equal to null. To force that a value is simply not equal to null, see the NotNull constraint.

Applies to	property or method
Options	message
Class	`Symfony\Component\Validator\Constraints\NotBlank`
Validator	`Symfony\Component\Validator\Constraints\NotBlankValidator`

Basic Usage¶

If you wanted to ensure that the firstName property of an Author class were not blank, you could do the following:

YAML

# src/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
    properties:
        firstName:
            - NotBlank: ~

Annotations

// src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
    /**
     * @Assert\NotBlank()
     */
    protected $firstName;
}

XML

<!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
<class name="Acme\BlogBundle\Entity\Author">
    <property name="firstName">
        <constraint name="NotBlank" />
    </property>
</class>

PHP

// 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\NotBlank());
    }
}

Options¶

message¶

type: string default: This value should not be blank

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

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