1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. NotBlank
WARNING: You are browsing the documentation for Symfony 2.1 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

NotBlank

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

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
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
    1
2
3
4
5
    # src/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
    properties:
        firstName:
            - NotBlank: ~
  • 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\NotBlank()
     */
    protected $firstName;
}
  • XML
    1
2
3
4
5
6
    <!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
<class name="Acme\BlogBundle\Entity\Author">
    <property name="firstName">
        <constraint name="NotBlank" />
    </property>
</class>
  • 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\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.