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

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

NotIdenticalTo

2.6 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
- Basic Usage
- Options
  - value
  - message
  - payload

NotIdenticalTo¶

New in version 2.3: The NotIdenticalTo constraint was introduced in Symfony 2.3.

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	value message payload
Class	`Symfony\Component\Validator\Constraints\NotIdenticalTo`
Validator	`Symfony\Component\Validator\Constraints\NotIdenticalToValidator`

Basic Usage¶

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

Annotations

// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

YAML

# src/Acme/SocialBundle/Resources/config/validation.yml
Acme\SocialBundle\Entity\Person:
    properties:
        age:
            - NotIdenticalTo:
                value: 15

XML

<!-- src/Acme/SocialBundle/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="Acme\SocialBundle\Entity\Person">
        <property name="age">
            <constraint name="NotIdenticalTo">
                <option name="value">15</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>

PHP

// src/Acme/SocialBundle/Entity/Person.php
namespace Acme\SocialBundle\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(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

New in version 2.6: The payload option was introduced in Symfony 2.6.

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.