EqualTo

Валидирует, что значение равно другому значению, определённому в опциях. Чтобы узнать, как обеспечить, чтобы значение не было равным, см. NotEqualTo.

Caution

Это ограничение сравнивает используя ==, так что 3 и "3" считаются равными. Используйте IdenticalTo, чтобы сравнить с ===.

Применяется к свойству или методу
Опции
Класс EqualTo
Валидатор EqualToValidator

Базовое применение

Если вы хотите убедиться, что firstName класса Person равно Mary, и что age - 20, вы можете сделать следующее:

  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    // 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;
    }
    
  • YAML
    1
    2
    3
    4
    5
    6
    7
    8
    # config/validator/validation.yaml
    App\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
    <!-- config/validator/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="App\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/Entity/Person.php
    namespace App\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,
            )));
        }
    }
    

Опции

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

тип: string по умолчанию: Это значение должно быть равно {{ compared_value }}.

Это сообщение, отображаемое, если значение не равно.

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.

propertyPath

type: string

It defines the object property whose value is used to make the comparison.

For example, if you want to compare the $endDate property of some object with regard to the $startDate property of the same object, use propertyPath="startDate" in the comparison constraint of $endDate.

Эта документация является переводом официальной документации Symfony и предоставляется по свободной лицензии CC BY-SA 3.0.