You are browsing the Symfony 4 documentation, which changes significantly from Symfony 3.x. If your app doesn't use Symfony 4 yet, browse the Symfony 3.4 documentation.

Length

4.1 version

Maintained

2.8 3.4 4.2 master

Unmaintained

2.1 2.2 2.3 2.4 2.5 2.6 2.7 3.0 3.1 3.2 3.3 4.0

edit this page

Length¶

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

Caution

null and empty strings are not handled by this constraint. You need to also add the NotBlank or NotNull constraints to validate against these.

Applies to	property or method
Options	min max charset minMessage maxMessage exactMessage payload
Class	`Length`
Validator	`LengthValidator`

Basic Usage¶

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

Annotations

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

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 long",
     *      maxMessage = "Your first name cannot be longer than {{ limit }} characters"
     * )
     */
     protected $firstName;
}

YAML

# config/validator/validation.yaml
App\Entity\Participant:
    properties:
        firstName:
            - Length:
                min: 2
                max: 50
                minMessage: 'Your first name must be at least {{ limit }} characters long'
                maxMessage: 'Your first name cannot be longer than {{ limit }} characters'

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

    <class name="App\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 long
                </option>
                <option name="maxMessage">
                    Your first name cannot be longer than {{ limit }} characters
                </option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

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

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

class Participant
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('firstName', new Assert\Length(array(
            'min'        => 2,
            'max'        => 50,
            'minMessage' => 'Your first name must be at least {{ limit }} characters long',
            'maxMessage' => 'Your first name cannot be longer than {{ limit }} characters',
        )));
    }
}

Options¶

min¶

type: integer

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

It is important to notice that NULL values and empty strings are considered valid no matter if the constraint required a minimum length. Validators are triggered only if the value is not blank.

max¶

type: integer

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 grapheme_strlen PHP function is used if available. If not, the mb_strlen PHP function is used if available. If neither are available, the 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.

payload¶

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

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