ExtensionExistsConstraint.php

Same filename in other branches
  1. 11.x core/lib/Drupal/Core/Extension/Plugin/Validation/Constraint/ExtensionExistsConstraint.php

Namespace

Drupal\Core\Extension\Plugin\Validation\Constraint

File

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

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\Extension\Plugin\Validation\Constraint;

use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Validation\Attribute\Constraint;
use Symfony\Component\Validator\Constraint as SymfonyConstraint;

/**
 * Checks that the value is the name of an installed extension.
 */
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() {
        return [
            'type',
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() {
        return 'type';
    }

}

Classes

Title Deprecated Summary
ExtensionExistsConstraint Checks that the value is the name of an installed extension.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.