class UniqueFieldConstraint

Checks if an entity field has a unique value.

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Drupal\Core\Validation\Plugin\Validation\Constraint\UniqueFieldConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of UniqueFieldConstraint

3 files declare their use of UniqueFieldConstraint
FileUriUnique.php in core/modules/file/src/Plugin/Validation/Constraint/FileUriUnique.php
UserMailUnique.php in core/modules/user/src/Plugin/Validation/Constraint/UserMailUnique.php
UserNameUnique.php in core/modules/user/src/Plugin/Validation/Constraint/UserNameUnique.php

File

core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/UniqueFieldConstraint.php, line 12

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint
View source 
class UniqueFieldConstraint extends SymfonyConstraint {
    public $message = 'A @entity_type with @field_name %value already exists.';
    
    /**
     * This constraint is case-insensitive by default.
     *
     * For example "FOO" and "foo" would be considered as equivalent, and
     * validation of the constraint would fail.
     *
     * @var bool
     */
    public $caseSensitive = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function validatedBy() : string {
        return '\\Drupal\\Core\\Validation\\Plugin\\Validation\\Constraint\\UniqueFieldValueValidator';
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Constraint::$groups public property The groups that the constraint belongs to.
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 2
Constraint::CLASS_CONSTRAINT public constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP public constant The name of the group given to all constraints with no explicit group.
Constraint::ERROR_NAMES protected constant Maps error codes to the names of their constants. 59
Constraint::getDefaultOption public function Returns the name of the default option. 28
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getRequiredOptions public function Returns the name of the required options. 22
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or
both. 		8
Constraint::normalizeOptions protected function
Constraint::PROPERTY_CONSTRAINT public constant Marks a constraint that can be put onto properties.
Constraint::__construct public function Initializes the constraint with options. 58
Constraint::__get public function Returns the value of a lazily initialized option. 2
Constraint::__isset public function 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
UniqueFieldConstraint::$caseSensitive public property This constraint is case-insensitive by default. 1
UniqueFieldConstraint::$message public property 3
UniqueFieldConstraint::validatedBy public function Returns the name of the class that validates this constraint. Overrides Constraint::validatedBy 1