Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages in full color showing how to combine Symfony with Docker, APIs, queues & async tasks, Webpack, Single-Page Applications, etc.

Buy printed version
WARNING: You are browsing the documentation for Symfony 2.0 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

Blank

Blank

Validates that a value is blank, defined as equal to a blank string or equal to null. To force that a value strictly be equal to null, see the Null constraint. To force that a value is not blank, see NotBlank.

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\Blank
Validator Symfony\Component\Validator\Constraints\BlankValidator

Basic Usage

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

  • YAML
    1
    2
    3
    4
    5
    # src/BlogBundle/Resources/config/validation.yml
    Acme\BlogBundle\Entity\Author:
        properties:
            firstName:
                - Blank: ~
    
  • 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\Blank()
         */
        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="Blank" />
        </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\Blank());
        }
    }
    

Options

message

type: string default: This value should be blank

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

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