You are browsing the documentation for Symfony 3.1 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
EqualTo
EqualTo¶
Validates that a value is equal to another value, defined in the options. To force that a value is not equal, see NotEqualTo.
Caution
This constraint compares using ==
, so 3
and "3"
are considered
equal. Use IdenticalTo to compare with
===
.
Applies to | property or method |
Options | |
Class | Symfony\Component\Validator\Constraints\EqualTo |
Validator | Symfony\Component\Validator\Constraints\EqualToValidator |
Basic Usage¶
If you want to ensure that the firstName
of a Person
class is equal to Mary
and that the age
is 20
, you could do the following:
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\EqualTo("Mary") */ protected $firstName; /** * @Assert\EqualTo( * value = 20 * ) */ protected $age; }
- YAML
1 2 3 4 5 6 7 8
# src/AppBundle/Resources/config/validation.yml AppBundle\Entity\Person: properties: firstName: - EqualTo: Mary age: - EqualTo: value: 20
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
<!-- src/AppBundle/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="AppBundle\Entity\Person"> <property name="firstName"> <constraint name="EqualTo"> <value>Mary</value> </constraint> </property> <property name="age"> <constraint name="EqualTo"> <option name="value">20</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/AppBundle/Entity/Person.php namespace AppBundle\Entity; use Symfony\Component\Validator\Mapping\ClassMetadata; use Symfony\Component\Validator\Constraints as Assert; class Person { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('firstName', new Assert\EqualTo('Mary')); $metadata->addPropertyConstraint('age', new Assert\EqualTo(array( 'value' => 20, ))); } }
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 equal to {{ compared_value }}.
This is the message that will be shown if the value is not equal.
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.
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.