MaxLength.rst

MaxLength

Validates that the length of a string is not larger than the given limit.

Applies to	:ref:`property or method<validation-property-target>`
Options	limit message charset
Class	:class:`Symfony\\Component\\Validator\\Constraints\\MaxLength`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\MaxLengthValidator`

Basic Usage

.. configuration-block::

    .. code-block:: yaml

        # src/Acme/BlogBundle/Resources/config/validation.yml
        Acme\BlogBundle\Entity\Blog:
            properties:
                summary:
                    - MaxLength: 100

    .. code-block:: php-annotations

        // src/Acme/BlogBundle/Entity/Blog.php
        use Symfony\Component\Validator\Constraints as Assert;

        class Blog
        {
            /**
             * @Assert\MaxLength(100)
             */
            protected $summary;
        }

    .. code-block:: xml

        <!-- src/Acme/BlogBundle/Resources/config/validation.xml -->
        <class name="Acme\BlogBundle\Entity\Blog">
            <property name="summary">
                <constraint name="MaxLength">
                    <value>100</value>
                </constraint>
            </property>
        </class>

Options

limit

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

This required option is the "max" value. Validation will fail if the length of the give string is greater than this number.

message

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

The message that will be shown if the underlying string has a length that is longer than the limit option.

charset

type: charset default: UTF-8

If the PHP extension "mbstring" is installed, then the PHP function mb_strlen will be used to calculate the length of the string. The value of the charset option is passed as the second argument to that function.