interface ContextAwarePluginInterface in Drupal 9

An override of ContextAwarePluginInterface for documentation purposes.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\Component\Plugin\ContextAwarePluginInterface
    • interface \Drupal\Core\Plugin\ContextAwarePluginInterface

See also

\Drupal\Component\Plugin\ContextAwarePluginInterface

\Drupal\Core\Plugin\ContextAwarePluginTrait

Related topics

Plugin API

Using the Plugin API

22 files declare their use of ContextAwarePluginInterface

BlockAccessControlHandler.php in core/modules/block/src/BlockAccessControlHandler.php

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

BlockForm.php in core/modules/block/src/BlockForm.php

BlockRepositoryTest.php in core/modules/block/tests/src/Unit/BlockRepositoryTest.php

Contains \Drupal\Tests\block\Unit\BlockRepositoryTest.

BlockViewBuilder.php in core/modules/block/src/BlockViewBuilder.php

... See full list

File

core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php, line 15

Namespace

Drupal\Core\Plugin

interface ContextAwarePluginInterface extends ComponentContextAwarePluginInterface {

  /**
   * Gets the context definitions of the plugin.
   *
   * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface[]
   *   The array of context definitions, keyed by context name.
   */
  public function getContextDefinitions();

  /**
   * Gets a specific context definition of the plugin.
   *
   * @param string $name
   *   The name of the context in the plugin definition.
   *
   * @return \Drupal\Core\Plugin\Context\ContextDefinitionInterface
   *   The definition against which the context value must validate.
   *
   * @throws \Drupal\Component\Plugin\Exception\ContextException
   *   If the requested context is not defined.
   */
  public function getContextDefinition($name);

}

Members

Name	Modifiers	Type	Description	Overrides
ContextAwarePluginInterface::getContext	public	function	Gets a defined context.	1
ContextAwarePluginInterface::getContextDefinition	public	function	Gets a specific context definition of the plugin. Overrides ContextAwarePluginInterface::getContextDefinition
ContextAwarePluginInterface::getContextDefinitions	public	function	Gets the context definitions of the plugin. Overrides ContextAwarePluginInterface::getContextDefinitions
ContextAwarePluginInterface::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::getContexts	public	function	Gets the defined contexts.	1
ContextAwarePluginInterface::getContextValue	public	function	Gets the value for a defined context.	1
ContextAwarePluginInterface::getContextValues	public	function	Gets the values for all defined contexts.	1
ContextAwarePluginInterface::setContext	public	function	Set a context on this plugin.	2
ContextAwarePluginInterface::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::setContextValue	public	function	Sets the value for a defined context.	1
ContextAwarePluginInterface::validateContexts	public	function	Validates the set values for the defined contexts.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2