class PluginExistsConstraint

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Plugin/Plugin/Validation/Constraint/PluginExistsConstraint.php \Drupal\Core\Plugin\Plugin\Validation\Constraint\PluginExistsConstraint

Checks if a plugin exists and optionally implements a particular interface.

Hierarchy

Expanded class hierarchy of PluginExistsConstraint

1 file declares its use of PluginExistsConstraint
PluginExistsConstraintTest.php in core/tests/Drupal/Tests/Core/Plugin/PluginExistsConstraintTest.php

File

core/lib/Drupal/Core/Plugin/Plugin/Validation/Constraint/PluginExistsConstraint.php, line 18

Namespace

Drupal\Core\Plugin\Plugin\Validation\Constraint
View source 
class PluginExistsConstraint extends SymfonyConstraint implements ContainerFactoryPluginInterface {
    
    /**
     * The error message if a plugin does not exist.
     *
     * @var string
     */
    public string $unknownPluginMessage = "The '@plugin_id' plugin does not exist.";
    
    /**
     * The error message if a plugin does not implement the expected interface.
     *
     * @var string
     */
    public string $invalidInterfaceMessage = "The '@plugin_id' plugin must implement or extend @interface.";
    
    /**
     * The ID of the plugin manager service.
     *
     * @var string
     */
    protected string $manager;
    
    /**
     * Optional name of the interface that the plugin must implement.
     *
     * @var string|null
     */
    public ?string $interface = NULL;
    
    /**
     * Whether or not to consider fallback plugin IDs as valid.
     *
     * @var bool
     */
    public bool $allowFallback = FALSE;
    
    /**
     * Constructs a PluginExistsConstraint.
     *
     * @param \Drupal\Component\Plugin\PluginManagerInterface $pluginManager
     *   The plugin manager associated with the constraint.
     * @param mixed|null $options
     *   The options (as associative array) or the value for the default option
     *   (any other type).
     * @param array|null $groups
     *   An array of validation groups.
     * @param mixed|null $payload
     *   Domain-specific data attached to a constraint.
     */
    public function __construct(PluginManagerInterface $pluginManager, mixed $options = NULL, ?array $groups = NULL, mixed $payload = NULL) {
        parent::__construct($options, $groups, $payload);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        $plugin_manager_id = $configuration['manager'] ?? $configuration['value'] ?? NULL;
        if ($plugin_manager_id === NULL) {
            throw new MissingOptionsException(sprintf('The option "manager" must be set for constraint "%s".', static::class), [
                'manager',
            ]);
        }
        return new static($container->get($plugin_manager_id), $configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() : ?string {
        return 'manager';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRequiredOptions() : array {
        return [
            'manager',
        ];
    }

}

Members

Title Modifiers Object type Summary Overriden Title
PluginExistsConstraint::$allowFallback public property Whether or not to consider fallback plugin IDs as valid.
PluginExistsConstraint::$interface public property Optional name of the interface that the plugin must implement.
PluginExistsConstraint::$invalidInterfaceMessage public property The error message if a plugin does not implement the expected interface.
PluginExistsConstraint::$manager protected property The ID of the plugin manager service.
PluginExistsConstraint::$unknownPluginMessage public property The error message if a plugin does not exist.
PluginExistsConstraint::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PluginExistsConstraint::getDefaultOption public function
PluginExistsConstraint::getRequiredOptions public function
PluginExistsConstraint::__construct public function Constructs a PluginExistsConstraint.

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