function PluginExistsConstraint::create

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Plugin/Plugin/Validation/Constraint/PluginExistsConstraint.php \Drupal\Core\Plugin\Plugin\Validation\Constraint\PluginExistsConstraint::create()
  2. 10 core/lib/Drupal/Core/Plugin/Plugin/Validation/Constraint/PluginExistsConstraint.php \Drupal\Core\Plugin\Plugin\Validation\Constraint\PluginExistsConstraint::create()

Creates an instance of the plugin.

Parameters

\Symfony\Component\DependencyInjection\ContainerInterface $container: The container to pull out services used in the plugin.

array $configuration: A configuration array containing information about the plugin instance.

string $plugin_id: The plugin ID for the plugin instance.

mixed $plugin_definition: The plugin implementation definition.

Return value

static Returns an instance of this plugin.

Overrides ContainerFactoryPluginInterface::create

2 calls to PluginExistsConstraint::create()
PluginExistsConstraintTest::testManagerOption in core/tests/Drupal/Tests/Core/Plugin/PluginExistsConstraintTest.php
Tests plugin is created when manager option is set to a valid service ID.
PluginExistsConstraintTest::testMissingOption in core/tests/Drupal/Tests/Core/Plugin/PluginExistsConstraintTest.php
Tests missing option.

File

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

Class

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

Namespace

Drupal\Core\Plugin\Plugin\Validation\Constraint

Code

public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
  if (isset($configuration['value'])) {
    $configuration['manager'] ??= $configuration['value'];
    unset($configuration['value']);
    @trigger_error('Passing the "value" option in configuration to ' . __METHOD__ . ' is deprecated in drupal:11.4.0 and will not be supported in drupal:12.0.0. See https://www.drupal.org/node/3554746', E_USER_DEPRECATED);
  }
  $configuration['manager'] ??= NULL;
  $plugin_manager_id = $configuration['manager'];
  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);
}

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