class ConfigExistsConstraint

Checks that the value is the name of an existing config object.

Hierarchy

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

Expanded class hierarchy of ConfigExistsConstraint

File

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

Namespace

Drupal\Core\Config\Plugin\Validation\Constraint

View source

class ConfigExistsConstraint extends SymfonyConstraint {
    
    /**
     * The error message.
     *
     * @var string
     */
    public string $message = "The '@name' config does not exist.";
    
    /**
     * Optional prefix, to be specified when this contains a config entity ID.
     *
     * Every config entity type can have multiple instances, all with unique IDs
     * but the same config prefix. When config refers to a config entity,
     * typically only the ID is stored, not the prefix.
     *
     * @var string
     */
    public string $prefix = '';

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overrides
ConfigExistsConstraint::$message	public	property	The error message.
ConfigExistsConstraint::$prefix	public	property	Optional prefix, to be specified when this contains a config entity ID.
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.