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

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

GreaterThanOrEqual

GreaterThanOrEqual

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

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
Options
Class Symfony\Component\Validator\Constraints\GreaterThanOrEqual
Validator Symfony\Component\Validator\Constraints\GreaterThanOrEqualValidator

Basic Usage

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

  • YAML
    1
    2
    3
    4
    5
    6
    # src/Acme/SocialBundle/Resources/config/validation.yml
    Acme\SocialBundle\Entity\Person:
        properties:
            age:
                - GreaterThanOrEqual:
                    value: 18
    
  • Annotations
     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\GreaterThanOrEqual(
         *     value = 18
         * )
         */
        protected $age;
    }
    
  • XML
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    <!-- 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="GreaterThanOrEqual">
                    <option name="value">18</option>
                </constraint>
            </property>
        </class>
    </constraint-mapping>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    // 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\GreaterThanOrEqual(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 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.

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