NotIdenticalTo.rst

NotIdenticalTo

Validates that a value is not identical to another value, defined in the options. To force that a value is identical, see :doc:`/reference/constraints/IdenticalTo`.

Caution!

This constraint compares using !==, so 3 and "3" are considered not equal. Use :doc:`/reference/constraints/NotEqualTo` to compare with !=.

Applies to	:ref:`property or method <validation-property-target>`
Class	:class:`Symfony\\Component\\Validator\\Constraints\\NotIdenticalTo`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\NotIdenticalToValidator`

Basic Usage

The following constraints ensure that:

• firstName of Person is not equal to Mary or not of the same type
• age of Person class is not equal to 15 or not of the same type

.. configuration-block::

    .. code-block:: php-annotations

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

        use Symfony\Component\Validator\Constraints as Assert;

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

            /**
             * @Assert\NotIdenticalTo(
             *     value = 15
             * )
             */
            protected $age;
        }

    .. code-block:: php-attributes

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

        use Symfony\Component\Validator\Constraints as Assert;

        class Person
        {
            #[Assert\NotIdenticalTo('Mary')]
            protected $firstName;

            #[Assert\NotIdenticalTo(
                value: 15,
            )]
            protected $age;
        }

    .. code-block:: yaml

        # config/validator/validation.yaml
        App\Entity\Person:
            properties:
                firstName:
                    - NotIdenticalTo: Mary
                age:
                    - NotIdenticalTo:
                        value: 15

    .. code-block:: xml

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

    .. 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('age', new Assert\NotIdenticalTo('Mary'));

                $metadata->addPropertyConstraint('age', new Assert\NotIdenticalTo([
                    'value' => 15,
                ]));
            }
        }

Options

message

type: string default: This value should not be identical to {{ compared_value_type }} {{ compared_value }}.

This is the message that will be shown if the value is 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