Cover of the book Symfony 5: The Fast Track

Symfony 5: The Fast Track is the best book to learn modern Symfony development, from zero to production. +300 pages showcasing Symfony with Docker, APIs, queues & async tasks, Webpack, SPAs, etc.

  1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. NotEqualTo
WARNING:

You are browsing the documentation for Symfony 3.1 which is not maintained anymore.

Consider upgrading your projects to Symfony 5.2.

NotEqualTo

3.1 version
Maintained
4.4 5.2 current 5.3 dev
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

NotEqualTo

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

Caution

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

Applies to property or method
Options
Class Symfony\Component\Validator\Constraints\NotEqualTo
Validator Symfony\Component\Validator\Constraints\NotEqualToValidator

Basic Usage

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

  • 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\NotEqualTo("Mary")
     */
    protected $firstName;

    /**
     * @Assert\NotEqualTo(
     *     value = 15
     * )
     */
    protected $age;
}
  • YAML
    1
2
3
4
5
6
7
8
    # src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Person:
    properties:
        firstName:
            - NotEqualTo: Mary
        age:
            - NotEqualTo:
                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="NotEqualTo">
                <value>Mary</value>
            </constraint>
        </property>
        <property name="age">
            <constraint name="NotEqualTo">
                <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('firstName', new Assert\NotEqualTo('Mary'));

        $metadata->addPropertyConstraint('age', new Assert\NotEqualTo(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 equal to {{ compared_value }}.

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