Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Plugin/ContextAwarePluginInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,38 @@ +<?php + +namespace Drupal\Core\Plugin; + +use Drupal\Component\Plugin\ContextAwarePluginInterface as ComponentContextAwarePluginInterface; + +/** + * An override of ContextAwarePluginInterface for documentation purposes. + * + * @see \Drupal\Component\Plugin\ContextAwarePluginInterface + * + * @ingroup plugin_api + */ +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); + +}