Skip to content

Latest commit

 

History

History
108 lines (77 loc) · 3.3 KB

NotBlank.rst

File metadata and controls

108 lines (77 loc) · 3.3 KB

NotBlank

Validates that a value is not blank - meaning not equal to a blank string, a blank array, false or null (null behavior is configurable). To check that a value is not equal to null, see the :doc:`/reference/constraints/NotNull` constraint.

Applies to :ref:`property or method <validation-property-target>`
Class :class:`Symfony\\Component\\Validator\\Constraints\\NotBlank`
Validator :class:`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:

.. configuration-block::

    .. code-block:: php-attributes

        // src/Entity/Author.php
        namespace App\Entity;

        use Symfony\Component\Validator\Constraints as Assert;

        class Author
        {
            #[Assert\NotBlank]
            protected string $firstName;
        }

    .. code-block:: yaml

        # config/validator/validation.yaml
        App\Entity\Author:
            properties:
                firstName:
                    - NotBlank: ~

    .. code-block:: xml

        <!-- 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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

            <class name="App\Entity\Author">
                <property name="firstName">
                    <constraint name="NotBlank"/>
                </property>
            </class>
        </constraint-mapping>

    .. code-block:: php

        // src/Entity/Author.php
        namespace App\Entity;

        use Symfony\Component\Validator\Constraints as Assert;
        use Symfony\Component\Validator\Mapping\ClassMetadata;

        class Author
        {
            // ...

            public static function loadValidatorMetadata(ClassMetadata $metadata): void
            {
                $metadata->addPropertyConstraint('firstName', new Assert\NotBlank());
            }
        }

Options

allowNull

type: boolean default: false

If set to true, null values are considered valid and won't trigger a constraint violation.

message

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

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

You can use the following parameters in this message:

Parameter Description
{{ value }} The current (invalid) value
{{ label }} Corresponding form field label