IdenticalTo
Warning: You are browsing the documentation for Symfony 6.0, which is no longer maintained.
Read the updated version of this page for Symfony 7.1 (the current stable version).
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 |
Class | IdenticalTo |
Validator | IdenticalToValidator |
Basic Usage
The following constraints ensure that:
firstName
ofPerson
class is equal toMary
and is a stringage
is equal to20
and is of type integer
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/Entity/Person.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
#[Assert\IdenticalTo('Mary')]
protected $firstName;
#[Assert\IdenticalTo(
value: 20,
)]
protected $age;
}
1 2 3 4 5 6 7 8
# config/validator/validation.yaml
App\Entity\Person:
properties:
firstName:
- IdenticalTo: Mary
age:
- IdenticalTo:
value: 20
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 https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
<class name="App\Entity\Person">
<property name="firstName">
<constraint name="IdenticalTo">
Mary
</constraint>
</property>
<property name="age">
<constraint name="IdenticalTo">
<option name="value">20</option>
</constraint>
</property>
</class>
</constraint-mapping>
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\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;
class Person
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('firstName', new Assert\IdenticalTo('Mary'));
$metadata->addPropertyConstraint('age', new Assert\IdenticalTo([
'value' => 20,
]));
}
}
Options
groups
type: array
| string
It defines the validation group or groups of this constraint. Read more about validation groups.
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.
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 |
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
.
Tip
When using this option, its value is available in error messages as the
{{ compared_value_path }}
placeholder. Although it's not intended to
include it in the error messages displayed to end users, it's useful when
using APIs for doing any mapping logic on client-side.
value
type: mixed
[default option]
This option is required. It defines the comparison value. It can be a string, number or object.