WARNING: You are browsing the documentation for Symfony 3.0 which is not maintained anymore. Consider upgrading your projects to Symfony 4.3.

IdenticalTo

3.0 version

Maintained

3.4 4.2 4.3 current 4.4 master

Unmaintained

2.3 2.4 2.5 2.6 2.7 2.8 3.1 3.2 3.3 4.0 4.1

IdenticalTo¶

Validates that a value is identical to another value, defined in the options. To force that a value is not identical, see NotIdenticalTo.

Caution

This constraint compares using ===, so 3 and "3" are not considered equal. Use EqualTo to compare with ==.

Applies to	property or method
Options	value message payload
Class	`IdenticalTo`
Validator	`IdenticalToValidator`

Basic Usage¶

The following constraints ensure that:

firstName of Person class is equal to Mary and is a string
age is equal to``20`` and is of type integer

Annotations

// src/AppBundle/Entity/Person.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Person
{
    /**
     * @Assert\IdenticalTo("Mary")
     */
    protected $firstName;

    /**
     * @Assert\IdenticalTo(
     *     value = 20
     * )
     */
    protected $age;
}

YAML

# src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Person:
    properties:
        age:
            - IdenticalTo:
                value: 20

XML

<!-- 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="age">
            <constraint name="IdenticalTo">
                <option name="value">20</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// 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('age', new Assert\IdenticalTo(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 identical to {{ compared_value_type }} {{ compared_value }}.

This is the message that will be shown if the value is not identical.

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.