Length.rst

Length

Validates that a given string length is between some minimum and maximum value.

.. versionadded:: 2.1
    The Length constraint was added in Symfony 2.1.

Applies to	:ref:`property or method<validation-property-target>`
Options	min max charset minMessage maxMessage exactMessage
Class	:class:`Symfony\\Component\\Validator\\Constraints\\Length`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\LengthValidator`

Basic Usage

To verify that the firstName field length of a class is between "2" and "50", you might add the following:

.. configuration-block::

    .. code-block:: yaml

        # src/Acme/EventBundle/Resources/config/validation.yml
        Acme\EventBundle\Entity\Participant:
            properties:
                firstName:
                    - Length:
                        min: 2
                        max: 50
                        minMessage: "Your first name must be at least {{ limit }} characters length"
                        maxMessage: "Your first name cannot be longer than than {{ limit }} characters length"

    .. code-block:: php-annotations

        // src/Acme/EventBundle/Entity/Participant.php
        use Symfony\Component\Validator\Constraints as Assert;

        class Participant
        {
            /**
             * @Assert\Length(
             *      min = "2",
             *      max = "50",
             *      minMessage = "Your first name must be at least {{ limit }} characters length",
             *      maxMessage = "Your first name cannot be longer than than {{ limit }} characters length"
             * )
             */
             protected $firstName;
        }

    .. code-block:: xml

        <!-- src/Acme/EventBundle/Resources/config/validation.xml -->
        <class name="Acme\EventBundle\Entity\Participant">
            <property name="firstName">
                <constraint name="Length">
                    <option name="min">2</option>
                    <option name="max">50</option>
                    <option name="minMessage">Your first name must be at least {{ limit }} characters length</option>
                    <option name="maxMessage">Your first name cannot be longer than than {{ limit }} characters length</option>
                </constraint>
            </property>
        </class>

Options

min

type: integer [:ref:`default option<validation-default-option>`]

This required option is the "min" length value. Validation will fail if the given value's length is less than this min value.

max

type: integer [:ref:`default option<validation-default-option>`]

This required option is the "max" length value. Validation will fail if the given value's length is greater than this max value.

charset

type: string default: UTF-8

The charset to be used when computing value's length. The :phpfunction:`grapheme_strlen` PHP function is used if available. If not, the the :phpfunction:`mb_strlen` PHP function is used if available. If neither are available, the :phpfunction:`strlen` PHP function is used.

minMessage

type: string default: This value is too short. It should have {{ limit }} characters or more..

The message that will be shown if the underlying value's length is less than the min option.

maxMessage

type: string default: This value is too long. It should have {{ limit }} characters or less..

The message that will be shown if the underlying value's length is more than the max option.

exactMessage

type: string default: This value should have exactly {{ limit }} characters..

The message that will be shown if min and max values are equal and the underlying value's length is not exactly this value.