class ExtensionExistsConstraint

Checks that the value is the name of an installed extension.

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Drupal\Core\Extension\Plugin\Validation\Constraint\ExtensionExistsConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of ExtensionExistsConstraint

File

core/lib/Drupal/Core/Extension/Plugin/Validation/Constraint/ExtensionExistsConstraint.php, line 14

Namespace

Drupal\Core\Extension\Plugin\Validation\Constraint
View source 
class ExtensionExistsConstraint extends SymfonyConstraint {
    
    /**
     * The error message for a non-existent module.
     *
     * @var string
     */
    public string $moduleMessage = "Module '@name' is not installed.";
    
    /**
     * The error message for a non-existent theme.
     *
     * @var string
     */
    public string $themeMessage = "Theme '@name' is not installed.";
    
    /**
     * The type of extension to look for. Can be 'module' or 'theme'.
     *
     * @var string
     */
    public string $type;
    
    /**
     * {@inheritdoc}
     */
    public function getRequiredOptions() : array {
        return [
            'type',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() : ?string {
        return 'type';
    }

}

Members

Title 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.
ExtensionExistsConstraint::$moduleMessage public property The error message for a non-existent module.
ExtensionExistsConstraint::$themeMessage public property The error message for a non-existent theme.
ExtensionExistsConstraint::$type public property The type of extension to look for. Can be 'module' or 'theme'.
ExtensionExistsConstraint::getDefaultOption public function Returns the name of the default option. Overrides Constraint::getDefaultOption
ExtensionExistsConstraint::getRequiredOptions public function Returns the name of the required options. Overrides Constraint::getRequiredOptions