EqualTo ======= Validates that a value is equal to another value, defined in the options. To force that a value is *not* equal, see :doc:`/reference/constraints/NotEqualTo`. .. caution:: This constraint compares using ``==``, so ``3`` and ``"3"`` are considered equal. Use :doc:`/reference/constraints/IdenticalTo` to compare with ``===``. ========== =================================================================== Applies to :ref:`property or method ` Options - `groups`_ - `message`_ - `payload`_ - `propertyPath`_ - `value`_ Class :class:`Symfony\\Component\\Validator\\Constraints\\EqualTo` Validator :class:`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: .. configuration-block:: .. code-block:: php-annotations // src/Entity/Person.php namespace App\Entity; use Symfony\Component\Validator\Constraints as Assert; class Person { /** * @Assert\EqualTo("Mary") */ protected $firstName; /** * @Assert\EqualTo( * value = 20 * ) */ protected $age; } .. code-block:: yaml # config/validator/validation.yaml App\Entity\Person: properties: firstName: - EqualTo: Mary age: - EqualTo: value: 20 .. code-block:: xml Mary .. code-block:: php // src/Entity/Person.php namespace App\Entity; use Symfony\Component\Validator\Constraints as Assert; use Symfony\Component\Validator\Mapping\ClassMetadata; class Person { public static function loadValidatorMetadata(ClassMetadata $metadata) { $metadata->addPropertyConstraint('firstName', new Assert\EqualTo('Mary')); $metadata->addPropertyConstraint('age', new Assert\EqualTo([ 'value' => 20, ])); } } Options ------- .. include:: /reference/constraints/_groups-option.rst.inc ``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. You can use the following parameters in this message: ============================= ================================================ Parameter Description ============================= ================================================ ``{{ compared_value }}`` The expected value ``{{ compared_value_type }}`` The expected value type ``{{ value }}`` The current (invalid) value ============================= ================================================ .. include:: /reference/constraints/_payload-option.rst.inc .. include:: /reference/constraints/_comparison-propertypath-option.rst.inc .. include:: /reference/constraints/_comparison-value-option.rst.inc