class UniqueFieldConstraint in Zircon Profile 8

Checks if an entity field has a unique value.

Plugin annotation

@Constraint(
  id = "UniqueField",
  label = @Translation("Unique field constraint", context = "Validation"),
)

Hierarchy

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

4 files declare their use of UniqueFieldConstraint

FeedTitleConstraint.php in core/modules/aggregator/src/Plugin/Validation/Constraint/FeedTitleConstraint.php

Contains \Drupal\aggregator\Plugin\Validation\Constraint\FeedTitleConstraint.

FeedUrlConstraint.php in core/modules/aggregator/src/Plugin/Validation/Constraint/FeedUrlConstraint.php

Contains \Drupal\aggregator\Plugin\Validation\Constraint\FeedUrlConstraint.

UserMailUnique.php in core/modules/user/src/Plugin/Validation/Constraint/UserMailUnique.php

Contains \Drupal\user\Plugin\Validation\Constraint\UserMailUnique.

UserNameUnique.php in core/modules/user/src/Plugin/Validation/Constraint/UserNameUnique.php

Contains \Drupal\user\Plugin\Validation\Constraint\UserNameUnique.

File

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

Contains \Drupal\Core\Validation\Plugin\Validation\Constraint\UniqueFieldConstraint.

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint

class UniqueFieldConstraint extends Constraint {
  public $message = 'A @entity_type with @field_name %value already exists.';

  /**
   * {@inheritdoc}
   */
  public function validatedBy() {
    return '\\Drupal\\Core\\Validation\\Plugin\\Validation\\Constraint\\UniqueFieldValueValidator';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Constraint::$errorNames	protected static	property	Maps error codes to the names of their constants.	16
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.	1
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
Constraint::getDefaultOption	public	function	Returns the name of the default option.	18
Constraint::getErrorName	public static	function	Returns the name of the given error code.
Constraint::getRequiredOptions	public	function	Returns the name of the required options.	11
Constraint::getTargets	public	function	Returns whether the constraint can be put onto classes, properties or both.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::__construct	public	function	Initializes the constraint with options.	11
Constraint::__get	public	function	Returns the value of a lazily initialized option.	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::$message	public	property		4
UniqueFieldConstraint::validatedBy	public	function	Returns the name of the class that validates this constraint. Overrides Constraint::validatedBy