class AtLeastOneOf
Checks that at least one of the given constraint is satisfied.
@author Przemysław Bogusz <przemyslaw.bogusz@tubotax.pl>
Hierarchy
- class \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\Composite extends \Symfony\Component\Validator\Constraint
- class \Symfony\Component\Validator\Constraints\AtLeastOneOf extends \Symfony\Component\Validator\Constraints\Composite
- class \Symfony\Component\Validator\Constraints\Composite extends \Symfony\Component\Validator\Constraint
Expanded class hierarchy of AtLeastOneOf
1 file declares its use of AtLeastOneOf
- Recipe.php in core/
lib/ Drupal/ Core/ Recipe/ Recipe.php
File
-
vendor/
symfony/ validator/ Constraints/ AtLeastOneOf.php, line 21
Namespace
Symfony\Component\Validator\ConstraintsView source
class AtLeastOneOf extends Composite {
public const AT_LEAST_ONE_OF_ERROR = 'f27e6d6c-261a-4056-b391-6673a623531c';
protected const ERROR_NAMES = [
self::AT_LEAST_ONE_OF_ERROR => 'AT_LEAST_ONE_OF_ERROR',
];
public array|Constraint $constraints = [];
public string $message = 'This value should satisfy at least one of the following constraints:';
public string $messageCollection = 'Each element of this collection should satisfy its own set of constraints.';
public bool $includeInternalMessages = true;
/**
* @param array<Constraint>|array<string,mixed>|null $constraints An array of validation constraints
* @param string[]|null $groups
* @param string|null $message Intro of the failure message that will be followed by the failed constraint(s) message(s)
* @param string|null $messageCollection Failure message for All and Collection inner constraints
* @param bool|null $includeInternalMessages Whether to include inner constraint messages (defaults to true)
*/
public function __construct(mixed $constraints = null, ?array $groups = null, mixed $payload = null, ?string $message = null, ?string $messageCollection = null, ?bool $includeInternalMessages = null) {
parent::__construct($constraints ?? [], $groups, $payload);
$this->message = $message ?? $this->message;
$this->messageCollection = $messageCollection ?? $this->messageCollection;
$this->includeInternalMessages = $includeInternalMessages ?? $this->includeInternalMessages;
}
public function getDefaultOption() : ?string {
return 'constraints';
}
public function getRequiredOptions() : array {
return [
'constraints',
];
}
protected function getCompositeOption() : string {
return 'constraints';
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AtLeastOneOf::$constraints | public | property | |||
AtLeastOneOf::$includeInternalMessages | public | property | |||
AtLeastOneOf::$message | public | property | |||
AtLeastOneOf::$messageCollection | public | property | |||
AtLeastOneOf::AT_LEAST_ONE_OF_ERROR | public | constant | |||
AtLeastOneOf::ERROR_NAMES | protected | constant | Maps error codes to the names of their constants. | Overrides Constraint::ERROR_NAMES | |
AtLeastOneOf::getCompositeOption | protected | function | Returns the name of the property that contains the nested constraints. | Overrides Composite::getCompositeOption | |
AtLeastOneOf::getDefaultOption | public | function | Returns the name of the default option. | Overrides Constraint::getDefaultOption | |
AtLeastOneOf::getRequiredOptions | public | function | Returns the name of the required options. | Overrides Constraint::getRequiredOptions | |
AtLeastOneOf::__construct | public | function | Overrides Composite::__construct | ||
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 | |
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::getErrorName | public static | function | Returns the name of the given error code. | ||
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::__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. |