1. 8.5.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  2. 8.5.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  3. 8.0.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  4. 8.0.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  5. 8.1.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  6. 8.1.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  7. 8.2.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  8. 8.2.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  9. 8.3.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  10. 8.3.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  11. 8.4.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  12. 8.4.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  13. 8.6.x core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface
  14. 8.6.x core/lib/Drupal/Component/Plugin/ContextAwarePluginInterface.php ContextAwarePluginInterface

An override of ContextAwarePluginInterface for documentation purposes.

Hierarchy

Expanded class hierarchy of ContextAwarePluginInterface

All classes that implement ContextAwarePluginInterface

See also

\Drupal\Component\Plugin\ContextAwarePluginInterface

Related topics

7 files declare their use of ContextAwarePluginInterface

File

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

Namespace

Drupal\Core\Plugin
View source
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\PluginException
   *   If the requested context is not defined.
   */
  public function getContextDefinition($name);

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description Overrides
ContextAwarePluginInterface::getContext public function Gets a defined context.
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.
ContextAwarePluginInterface::getContextValue public function Gets the value for a defined context.
ContextAwarePluginInterface::getContextValues public function Gets the values for all defined contexts.
ContextAwarePluginInterface::setContext public function Set a context on this plugin.
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.
ContextAwarePluginInterface::validateContexts public function Validates the set values for the defined contexts.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation.
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance.