IdenticalTo

Version: 2.5
Edit this page

Warning: You are browsing the documentation for Symfony 2.5, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

IdenticalTo

New in version 2.3

The IdenticalTo constraint was introduced in Symfony 2.3.

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
Class IdenticalTo
Validator IdenticalToValidator

Basic Usage

If you want to ensure that the age of a Person class is equal to 20 and an integer, you could do the following:

  • YAML
  • Annotations
  • XML
  • PHP
1
2
3
4
5
6
# src/Acme/SocialBundle/Resources/config/validation.yml
Acme\SocialBundle\Entity\Person:
    properties:
        age:
            - IdenticalTo:
                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.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.