WARNING: You are browsing the documentation for Symfony 2.4 which is not maintained anymore. Consider upgrading your projects to Symfony 5.1.

GreaterThan

2.4 version

Maintained

3.4 4.4 5.1 current 5.2 master

Unmaintained

2.3 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2 4.3 5.0

GreaterThan
- Basic Usage
- Options
  - value
  - message

GreaterThan¶

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

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

Applies to	property or method
Options	value message
Class	`Symfony\Component\Validator\Constraints\GreaterThan`
Validator	`Symfony\Component\Validator\Constraints\GreaterThanValidator`

Basic Usage¶

If you want to ensure that the age of a Person class is greater than 18, you could do the following:

YAML

# src/Acme/SocialBundle/Resources/config/validation.yml
Acme\SocialBundle\Entity\Person:
    properties:
        age:
            - GreaterThan:
                value: 18

Annotations

// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

XML

<!-- src/Acme/SocialBundle/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="Acme\SocialBundle\Entity\Person">
        <property name="age">
            <constraint name="GreaterThan">
                <option name="value">18</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\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\GreaterThan(array(
            'value' => 18,
        )));
    }
}

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 greater than {{ compared_value }}.

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

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