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

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

LessThanOrEqual

2.3 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

LessThanOrEqual
- Basic Usage
- Options
  - value
  - message

LessThanOrEqual¶

New in version 2.3: The LessThanOrEqual constraint was introduced in Symfony 2.3.

Validates that a value is less than or equal to another value, defined in the options. To force that a value is less than another value, see LessThan.

Applies to	property or method
Options	value message
Class	`Symfony\Component\Validator\Constraints\LessThanOrEqual`
Validator	`Symfony\Component\Validator\Constraints\LessThanOrEqualValidator`

Basic Usage¶

If you want to ensure that the age of a Person class is less than or equal to 80, you could do the following:

Annotations

// src/AppBundle/Entity/Person.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    /**
     * @Assert\LessThanOrEqual(
     *     value = 80
     * )
     */
    protected $age;
}

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Person:
    properties:
        age:
            - LessThanOrEqual:
                value: 80

XML

<!-- src/AppBundle/Resources/config/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="AppBundle\Entity\Person">
        <property name="age">
            <constraint name="LessThanOrEqual">
                <option name="value">80</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// src/AppBundle/Entity/Person.php
namespace AppBundle\Entity;

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

class Person
{
    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('age', new Assert\LessThanOrEqual(array(
            'value' => 80,
        )));
    }
}

Options¶

value¶

type: mixed [default option]

This option is required. It defines the value to compare to. It can be a string, number or object.

message¶

type: string default: This value should be less than or equal to {{ compared_value }}.

This is the message that will be shown if the value is not less than or equal to the comparison value.

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