class 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

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

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
EntityConstraintViolationList.php in core/lib/Drupal/Core/Entity/EntityConstraintViolationList.php
MenuTreeHierarchyConstraint.php in core/modules/menu_link_content/src/Plugin/Validation/Constraint/MenuTreeHierarchyConstraint.php
TaxonomyTermHierarchyConstraint.php in core/modules/taxonomy/src/Plugin/Validation/Constraint/TaxonomyTermHierarchyConstraint.php

File

core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/CompositeConstraintBase.php, line 15

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

Title Modifiers Object type Summary Overrides
CompositeConstraintBase::coversFields abstract public function An array of entity fields which should be passed to the validator. 3
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::validatedBy public function Returns the name of the class that validates this constraint. 9
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.