|
| 1 | +GreaterThan |
| 2 | +=========== |
| 3 | + |
| 4 | +..versionadded::2.3 |
| 5 | + This constraint is new in version 2.3. |
| 6 | + |
| 7 | +Validates that a value is greater than another value, defined in the options. To |
| 8 | +force that a value is greater than or equal to another value, see |
| 9 | +:doc:`/reference/constraints/GreaterThanOrEqual`. To force a value is less |
| 10 | +than another value, see:doc:`/reference/constraints/LessThan`. |
| 11 | + |
| 12 | ++----------------+---------------------------------------------------------------------------+ |
| 13 | +| Applies to|:ref:`property or method<validation-property-target>`| |
| 14 | ++----------------+---------------------------------------------------------------------------+ |
| 15 | +| Options| - `value`_| |
| 16 | +|| - `message`_| |
| 17 | ++----------------+---------------------------------------------------------------------------+ |
| 18 | +| Class|:class:`Symfony\\Component\\Validator\\Constraints\\GreaterThan`| |
| 19 | ++----------------+---------------------------------------------------------------------------+ |
| 20 | +| Validator|:class:`Symfony\\Component\\Validator\\Constraints\\GreaterThanValidator`| |
| 21 | ++----------------+---------------------------------------------------------------------------+ |
| 22 | + |
| 23 | +Basic Usage |
| 24 | +----------- |
| 25 | + |
| 26 | +If you want to ensure that the ``age`` of a ``Person`` class is greater than |
| 27 | +``18``, you could do the following: |
| 28 | + |
| 29 | +..configuration-block:: |
| 30 | + |
| 31 | + ..code-block::yaml |
| 32 | +
|
| 33 | +# src/SocialBundle/Resources/config/validation.yml |
| 34 | +Acme\SocialBundle\Entity\Person: |
| 35 | +properties: |
| 36 | +age: |
| 37 | + -GreaterThan: |
| 38 | +value:18 |
| 39 | +
|
| 40 | + ..code-block::php-annotations |
| 41 | +
|
| 42 | + // src/Acme/SocialBundle/Entity/Person.php |
| 43 | + namespace Acme\SocialBundle\Entity; |
| 44 | +
|
| 45 | + use Symfony\Component\Validator\Constraints as Assert; |
| 46 | +
|
| 47 | + class Person |
| 48 | + { |
| 49 | + /** |
| 50 | + * @Assert\GreaterThan( |
| 51 | + * value = 18 |
| 52 | + * ) |
| 53 | + */ |
| 54 | + protected $age; |
| 55 | + } |
| 56 | +
|
| 57 | + ..code-block::xml |
| 58 | +
|
| 59 | +<!-- src/Acme/SocialBundle/Resources/config/validation.xml--> |
| 60 | + <classname="Acme\SocialBundle\Entity\Person"> |
| 61 | + <propertyname="age"> |
| 62 | + <constraintname="GreaterThan"> |
| 63 | + <optionname="value">18</option> |
| 64 | + </constraint> |
| 65 | + </property> |
| 66 | + </class> |
| 67 | +
|
| 68 | + ..code-block::php |
| 69 | +
|
| 70 | + // src/Acme/SocialBundle/Entity/Person.php |
| 71 | + namespace Acme\SocialBundle\Entity; |
| 72 | +
|
| 73 | + use Symfony\Component\Validator\Mapping\ClassMetadata; |
| 74 | + use Symfony\Component\Validator\Constraints as Assert; |
| 75 | +
|
| 76 | + class Person |
| 77 | + { |
| 78 | + public static function loadValidatorMetadata(ClassMetadata $metadata) |
| 79 | + { |
| 80 | + $metadata->addPropertyConstraint('age', new Assert\GreaterThan(array( |
| 81 | + 'value' => 18, |
| 82 | + ))); |
| 83 | + } |
| 84 | + } |
| 85 | +
|
| 86 | +Options |
| 87 | +------- |
| 88 | + |
| 89 | +..include::/reference/constraints/_comparison-value-option.rst.inc |
| 90 | + |
| 91 | +message |
| 92 | +~~~~~~~ |
| 93 | + |
| 94 | +**type**: ``string`` **default**: ``This value should be greater than {{ compared_value }}`` |
| 95 | + |
| 96 | +This is the message that will be shown if the value is not equal. |