SymfonyWorld Online 2021 Summer Edition
June 17 – 18, 2021
SymfonyWorld Online 2021 Winter Edition
December 9 – 10, 2021
  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. NotIdenticalTo

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

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

NotIdenticalTo

3.0 version
Maintained
4.4 5.3 current 5.4 dev 6.0
Unmaintained
2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

NotIdenticalTo

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

Caution

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

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\NotIdenticalTo
Validator 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
  • Annotations
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    // src/AppBundle/Entity/Person.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

    /**
     * @Assert\NotIdenticalTo(
     *     value = 15
     * )
     */
    protected $age;
}
  • YAML
    1
2
3
4
5
6
7
8
    # src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Person:
    properties:
        firstName:
            - NotIdenticalTo: Mary
        age:
            - NotIdenticalTo:
                value: 15
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
    <!-- 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="firstName">
            <constraint name="NotIdenticalTo">
                <value>Mary</value>
            </constraint>
        </property>
        <property name="age">
            <constraint name="NotIdenticalTo">
                <option name="value">15</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/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\NotIdenticalTo('Mary'));

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

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 not be identical to {{ compared_value_type }} {{ compared_value }}.

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

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.