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.

Range

Range

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

Applies to property or method
Options
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:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    // src/Entity/Participant.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Participant
    {
        /**
         * @Assert\Range(
         *      min = 120,
         *      max = 180,
         *      minMessage = "You must be at least {{ limit }}cm tall to enter",
         *      maxMessage = "You cannot be taller than {{ limit }}cm to enter"
         * )
         */
        protected $height;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    # config/validator/validation.yaml
    App\Entity\Participant:
        properties:
            height:
                - Range:
                    min: 120
                    max: 180
                    minMessage: You must be at least {{ limit }}cm tall to enter
                    maxMessage: You cannot be taller than {{ limit }}cm to enter
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    <!-- 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\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 {{ limit }}cm tall to enter</option>
                    <option name="maxMessage">You cannot be taller than {{ limit }}cm to enter</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    // src/Entity/Participant.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class Participant
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('height', new Assert\Range([
                'min' => 120,
                'max' => 180,
                'minMessage' => 'You must be at least {{ limit }}cm tall to enter',
                'maxMessage' => 'You cannot be taller than {{ limit }}cm to enter',
            ]));
        }
    }
    

Date Ranges

This constraint can be used to compare DateTime objects against date ranges. The minimum and maximum date of the range should be given as any date string accepted by the DateTime constructor. For example, you could check that a date must lie within the current year like this:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/Entity/Event.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Event
    {
        /**
         * @Assert\Range(
         *      min = "first day of January",
         *      max = "first day of January next year"
         * )
         */
        protected $startDate;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    # config/validator/validation.yaml
    App\Entity\Event:
        properties:
            startDate:
                - Range:
                    min: first day of January
                    max: first day of January next year
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    <!-- 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\Event">
            <property name="startDate">
                <constraint name="Range">
                    <option name="min">first day of January</option>
                    <option name="max">first day of January next year</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    // src/Entity/Event.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class Event
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('startDate', new Assert\Range([
                'min' => 'first day of January',
                'max' => 'first day of January next year',
            ]));
        }
    }
    

Be aware that PHP will use the server's configured timezone to interpret these dates. If you want to fix the timezone, append it to the date string:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/Entity/Event.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Event
    {
        /**
         * @Assert\Range(
         *      min = "first day of January UTC",
         *      max = "first day of January next year UTC"
         * )
         */
        protected $startDate;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    # config/validator/validation.yaml
    App\Entity\Event:
        properties:
            startDate:
                - Range:
                    min: first day of January UTC
                    max: first day of January next year UTC
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    <!-- 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\Event">
            <property name="startDate">
                <constraint name="Range">
                    <option name="min">first day of January UTC</option>
                    <option name="max">first day of January next year UTC</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    // src/Entity/Person.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class Event
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('startDate', new Assert\Range([
                'min' => 'first day of January UTC',
                'max' => 'first day of January next year UTC',
            ]));
        }
    }
    

The DateTime class also accepts relative dates or times. For example, you can check that a delivery date starts within the next five hours like this:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // src/Entity/Order.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Order
    {
        /**
         * @Assert\Range(
         *      min = "now",
         *      max = "+5 hours"
         * )
         */
        protected $deliveryDate;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    # config/validator/validation.yaml
    App\Entity\Order:
        properties:
            deliveryDate:
                - Range:
                    min: now
                    max: +5 hours
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    <!-- 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\Order">
            <property name="deliveryDate">
                <constraint name="Range">
                    <option name="min">now</option>
                    <option name="max">+5 hours</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    // src/Entity/Order.php
    namespace App\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    use Symfony\Component\Validator\Mapping\ClassMetadata;
    
    class Order
    {
        public static function loadValidatorMetadata(ClassMetadata $metadata)
        {
            $metadata->addPropertyConstraint('deliveryDate', new Assert\Range([
                'min' => 'now',
                'max' => '+5 hours',
            ]));
        }
    }
    

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

invalidMessage

type: string default: This value should be a valid number.

The message that will be shown if the underlying value is not a number (per the is_numeric PHP function).

You can use the following parameters in this message:

Parameter Description
{{ value }} The current (invalid) value

max

type: number or string (date format)

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

maxMessage

type: string default: This value should be {{ limit }} or less.

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

You can use the following parameters in this message:

Parameter Description
{{ limit }} The upper limit
{{ value }} The current (invalid) value

min

type: number or string (date format)

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

minMessage

type: string default: This value should be {{ limit }} or more.

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

You can use the following parameters in this message:

Parameter Description
{{ limit }} The lower limit
{{ value }} The current (invalid) 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.