Range

Warning: You are browsing the documentation for Symfony 2.1, which is no longer maintained.

Read the updated version of this page for Symfony 6.0 (the current stable version).

Basic Usage
Options
- min
- max
- minMessage
- maxMessage
- invalidMessage

Range

Validates that a given number is between some minimum and maximum number.

2.1

The Range constraint was added in Symfony 2.1.

Applies to	property or method
Options	min max minMessage maxMessage invalidMessage
Class	Range
Validator	RangeValidator

Basic Usage

To verify that the "height" field of a class is between "120" and "180", you might add the following:

YAML
Annotations
XML
PHP

        1
2
3
4
5
6
7
8
9
        # src/Acme/EventBundle/Resources/config/validation.yml
Acme\EventBundle\Entity\Participant:
    properties:
        height:
            - Range:
                min: 120
                max: 180
                minMessage: You must be at least 120cm tall to enter
                maxMessage: You cannot be taller than 180cm to enter
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        // src/Acme/EventBundle/Entity/Participant.php
namespace Acme\EventBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Participant
{
    /**
     * @Assert\Range(
     *      min = 120,
     *      max = 180,
     *      minMessage = "You must be at least 120cm tall to enter",
     *      maxMessage = "You cannot be taller than 180cm to enter"
     * )
     */
     protected $height;
}
    

        1
2
3
4
5
6
7
8
9
10
11
        <!-- src/Acme/EventBundle/Resources/config/validation.xml -->
<class name="Acme\EventBundle\Entity\Participant">
    <property name="height">
        <constraint name="Range">
            <option name="min">120</option>
            <option name="max">180</option>
            <option name="minMessage">You must be at least 120cm tall to enter</option>
            <option name="maxMessage">You cannot be taller than 180cm to enter</option>
        </constraint>
    </property>
</class>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
        // src/Acme/EventBundle/Entity/Participant.php
namespace Acme\EventBundle\Entity;

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

class Participant
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('height', new Assert\Range(array(
            'min'        => 120,
            'max'        => 180,
            'minMessage' => 'You must be at least 120cm tall to enter',
            'maxMessage' => 'You cannot be taller than 180cm to enter',
        )));
    }
}
    