Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Compound.php

class Compound

Same name in this branch
  1. 11.1.x vendor/phpdocumentor/type-resolver/src/Types/Compound.php \phpDocumentor\Reflection\Types\Compound

Extend this class to create a reusable set of constraints.

@author Maxime Steinhausser <maxime.steinhausser@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Composite extends \Symfony\Component\Validator\Constraint
      • class \Symfony\Component\Validator\Constraints\Compound extends \Symfony\Component\Validator\Constraints\Composite

Expanded class hierarchy of Compound

1 file declares its use of Compound
CompoundConstraintTestCase.php in vendor/symfony/validator/Test/CompoundConstraintTestCase.php

File

vendor/symfony/validator/Constraints/Compound.php, line 22

Namespace

Symfony\Component\Validator\Constraints
View source
abstract class Compound extends Composite {
    
    /** @var Constraint[] */
    public array $constraints = [];
    public function __construct(mixed $options = null, ?array $groups = null, mixed $payload = null) {
        if (isset($options[$this->getCompositeOption()])) {
            throw new ConstraintDefinitionException(\sprintf('You can\'t redefine the "%s" option. Use the "%s::getConstraints()" method instead.', $this->getCompositeOption(), __CLASS__));
        }
        $this->constraints = $this->getConstraints($this->normalizeOptions($options));
        parent::__construct($options, $groups, $payload);
    }
    protected final function getCompositeOption() : string {
        return 'constraints';
    }
    public final function validatedBy() : string {
        return CompoundValidator::class;
    }
    
    /**
     * @param array<string, mixed> $options
     *
     * @return Constraint[]
     */
    protected abstract function getConstraints(array $options) : array;

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
Composite::addImplicitGroupName public function Implicit group names are forwarded to nested constraints. Overrides Constraint::addImplicitGroupName
Composite::getNestedConstraints public function @internal Used by metadata
Composite::initializeNestedConstraints protected function Initializes the nested constraints. 1
Compound::$constraints public property @var Constraint[]
Compound::getCompositeOption final protected function Returns the name of the property that contains the nested constraints. Overrides Composite::getCompositeOption
Compound::getConstraints abstract protected function
Compound::validatedBy final public function Returns the name of the class that validates this constraint. Overrides Constraint::validatedBy
Compound::__construct public function The groups of the composite and its nested constraints are made
consistent using the following strategy:
Overrides Composite::__construct
Constraint::$groups public property The groups that the constraint belongs to.
Constraint::$payload public property Domain-specific data attached to a constraint.
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::__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.
RSS feed
Powered by Drupal