GreaterThanOrEqual

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

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

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

Applies to property or method
Class GreaterThanOrEqual
Validator GreaterThanOrEqualValidator

Basic Usage

The following constraints ensure that:

  • the number of siblings of a Person is greater than or equal to 5
  • the age of a Person class is greater than or equal to 18
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// src/Entity/Person.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    #[Assert\GreaterThanOrEqual(5)]
    protected int $siblings;

    #[Assert\GreaterThanOrEqual(
        value: 18,
    )]
    protected int $age;
}

Comparing Dates

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 at least be the current day:

1
2
3
4
5
6
7
8
9
10
// src/Entity/Order.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Order
{
    #[Assert\GreaterThanOrEqual('today')]
    protected \DateTimeInterface $deliveryDate;
}

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:

1
2
3
4
5
6
7
8
9
10
// src/Entity/Order.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Order
{
    #[Assert\GreaterThanOrEqual('today UTC')]
    protected \DateTimeInterface $deliveryDate;
}

The DateTime class also accepts relative dates or times. For example, you can check that the above delivery date starts at least five hours after the current time:

1
2
3
4
5
6
7
8
9
10
// src/Entity/Order.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Order
{
    #[Assert\GreaterThanOrEqual('+5 hours')]
    protected \DateTimeInterface $deliveryDate;
}

Options

groups

type: array | string default: null

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

message

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

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

You can use the following parameters in this message:

Parameter Description
{{ compared_value }} The lower limit
{{ compared_value_type }} The expected value type
{{ 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.

propertyPath

type: string default: null

It defines the object property whose value is used to make the comparison.

For example, if you want to compare the $endDate property of some object with regard to the $startDate property of the same object, use propertyPath="startDate" in the comparison constraint of $endDate.

Tip

When using this option, its value is available in error messages as the {{ compared_value_path }} placeholder. Although it's not intended to include it in the error messages displayed to end users, it's useful when using APIs for doing any mapping logic on client-side.

value

type: mixed [default option]

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

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