class RequiredConfigDependenciesConstraint

Checks that config dependencies contain specific types of entities.

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Drupal\Core\Config\Plugin\Validation\Constraint\RequiredConfigDependenciesConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of RequiredConfigDependenciesConstraint

File

core/lib/Drupal/Core/Config/Plugin/Validation/Constraint/RequiredConfigDependenciesConstraint.php, line 14

Namespace

Drupal\Core\Config\Plugin\Validation\Constraint

View source

class RequiredConfigDependenciesConstraint extends SymfonyConstraint {
    
    /**
     * The error message.
     *
     * @var string
     */
    public string $message = 'This @entity_type requires a @dependency_type.';
    
    /**
     * The IDs of entity types that need to exist in config dependencies.
     *
     * For example, if an entity requires a filter format in its config
     * dependencies, this should contain `filter_format`.
     *
     * @var string[]
     */
    public array $entityTypes = [];
    
    /**
     * {@inheritdoc}
     */
    public function getRequiredOptions() : array {
        return [
            'entityTypes',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() : ?string {
        return 'entityTypes';
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
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::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::__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.
RequiredConfigDependenciesConstraint::$entityTypes	public	property	The IDs of entity types that need to exist in config dependencies.
RequiredConfigDependenciesConstraint::$message	public	property	The error message.
RequiredConfigDependenciesConstraint::getDefaultOption	public	function	Returns the name of the default option.	Overrides Constraint::getDefaultOption
RequiredConfigDependenciesConstraint::getRequiredOptions	public	function	Returns the name of the required options.	Overrides Constraint::getRequiredOptions