interface ContextAwarePluginManagerInterface in Drupal 9

Provides an interface for plugin managers that support context-aware plugins.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\Core\Plugin\Context\ContextAwarePluginManagerInterface

1 file declares its use of ContextAwarePluginManagerInterface

BlockManagerInterface.php in core/lib/Drupal/Core/Block/BlockManagerInterface.php

File

core/lib/Drupal/Core/Plugin/Context/ContextAwarePluginManagerInterface.php, line 10

Namespace

Drupal\Core\Plugin\Context

interface ContextAwarePluginManagerInterface extends PluginManagerInterface {

  /**
   * Determines plugins whose constraints are satisfied by a set of contexts.
   *
   * @todo Use context definition objects after
   *   https://www.drupal.org/node/2281635.
   *
   * @param \Drupal\Component\Plugin\Context\ContextInterface[] $contexts
   *   An array of contexts.
   *
   * @return array
   *   An array of plugin definitions.
   *
   * @see \Drupal\Core\Plugin\FilteredPluginManagerInterface::getFilteredDefinitions()
   */
  public function getDefinitionsForContexts(array $contexts = []);

}

Members

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginManagerInterface::getDefinitionsForContexts	public	function	Determines plugins whose constraints are satisfied by a set of contexts.
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	1
FactoryInterface::createInstance	public	function	Creates a pre-configured instance of a plugin.	6
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	3