LessThanOrEqual
Edit this pageWarning: You are browsing the documentation for Symfony 2.6, which is no longer maintained.
Read the updated version of this page for Symfony 6.0 (the current stable version).
LessThanOrEqual
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 | LessThanOrEqual |
| Validator | 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
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
/**
* @Assert\LessThanOrEqual(
* value = 80
* )
*/
protected $age;
}Comparing Dates
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
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
/**
* @Assert\LessThanOrEqual("today")
*/
protected $age;
}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
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
/**
* @Assert\LessThanOrEqual("today UTC")
*/
protected $age;
}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
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
/**
* @Assert\LessThanOrEqual("-18 years")
*/
protected $age;
}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
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.
