You are browsing the documentation for Symfony 2.7 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
LessThanOrEqual
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 | |
Class | Symfony\Component\Validator\Constraints\LessThanOrEqual |
Validator | Symfony\Component\Validator\Constraints\LessThanOrEqualValidator |
Basic Usage¶
The following constraints ensure that:
- the number of
siblings
of aPerson
is less than or equal to5
- the
age
is less than or equal to80
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\LessThanOrEqual(5) */ protected $siblings; /** * @Assert\LessThanOrEqual( * value = 80 * ) */ protected $age; }
- YAML
1 2 3 4 5 6 7 8
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Person: properties: siblings: - LessThanOrEqual: 5 age: - LessThanOrEqual: value: 80
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<!-- 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="siblings"> <constraint name="LessThanOrEqual"> <value>5</value> </constraint> </property> <property name="age"> <constraint name="LessThanOrEqual"> <option name="value">80</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// 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('siblings', new Assert\LessThanOrEqual(5)); $metadata->addPropertyConstraint('age', new Assert\LessThanOrEqual(array( 'value' => 80, ))); } }
Comparing Dates¶
New in version 2.6: The feature to compare dates was introduced in Symfony 2.6.
This constraint can be used to compare DateTime
objects against any date
string accepted by the DateTime constructor. For example, you could check
that a date must be today or in the past like this:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\LessThanOrEqual("today") */ protected $age; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Person: properties: age: - LessThanOrEqual: today
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- 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">today</constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// 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('today')); } }
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
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\LessThanOrEqual("today UTC") */ protected $age; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Person: properties: age: - LessThanOrEqual: today UTC
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- 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">today UTC</constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// 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('today UTC')); } }
The DateTime
class also accepts relative dates or times. For example, you
can check that a person must be at least 18 years old like this:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\LessThanOrEqual("-18 years") */ protected $age; }
- YAML
1 2 3 4 5
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Person: properties: age: - LessThanOrEqual: -18 years
- XML
1 2 3 4 5 6 7 8 9 10 11 12
<!-- 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">-18 years</constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13
// 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('-18 years')); } }
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.
payload¶
type: mixed
default: null
New in version 2.6: The payload
option was introduced in Symfony 2.6.
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.