You are here

abstract class CompositeConstraintBase in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/CompositeConstraintBase.php \Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase

Provides a base class for constraints validating multiple fields.

The constraint must be defined on entity-level; i.e., added to the entity type.

Hierarchy

Expanded class hierarchy of CompositeConstraintBase

See also

\Drupal\Core\Entity\EntityType::addConstraint

4 files declare their use of CompositeConstraintBase
CommentNameConstraint.php in core/modules/comment/src/Plugin/Validation/Constraint/CommentNameConstraint.php
Contains \Drupal\comment\Plugin\Validation\Constraint\CommentNameConstraint.
EntityConstraintViolationList.php in core/lib/Drupal/Core/Entity/EntityConstraintViolationList.php
Contains \Drupal\Core\Entity\EntityConstraintViolationList.
EntityTestCompositeConstraint.php in core/modules/system/tests/modules/entity_test/src/Plugin/Validation/Constraint/EntityTestCompositeConstraint.php
Contains \Drupal\entity_test\Plugin\Validation\Constraint\EntityTestCompositeConstraint.
EntityValidationTest.php in core/modules/system/src/Tests/Entity/EntityValidationTest.php
Contains \Drupal\system\Tests\Entity\EntityValidationTest.

File

core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/CompositeConstraintBase.php, line 20
Contains \Drupal\Core\Entity\Plugin\Validation\Constraint\CompositeConstraintBase.

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint
View source
abstract class CompositeConstraintBase extends Constraint {

  /**
   * An array of entity fields which should be passed to the validator.
   *
   * @return string[]
   *   An array of field names.
   */
  public abstract function coversFields();

}

Members

Namesort descending Modifiers Type Description Overrides
CompositeConstraintBase::coversFields abstract public function An array of entity fields which should be passed to the validator. 2
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::validatedBy public function Returns the name of the class that validates this constraint. 11
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.