Gets a specific context definition of the plugin.

Parameters

string $name: The name of the context in the plugin definition.

Return value

\Drupal\Component\Plugin\Context\ContextDefinitionInterface The definition against which the context value must validate.

Overrides ContextAwarePluginInterface::getContextDefinition

3 calls to ContextAwarePluginBase::getContextDefinition()

ContextAwarePluginBase::createContextFromConfiguration in core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php

Creates context objects from any context mappings in configuration.

ContextAwarePluginBase::getContext in core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php

Gets a defined context.

ContextAwarePluginBase::setContextValue in core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php

Sets the value for a defined context.

File

core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php, line 92

Class

ContextAwarePluginBase

Base class for plugins that are context aware.

Namespace

Drupal\Component\Plugin

Code

public function getContextDefinition($name) {
  $definition = $this->getPluginDefinition();
  if ($definition instanceof ContextAwarePluginDefinitionInterface) {
    if ($definition->hasContextDefinition($name)) {
      return $definition->getContextDefinition($name);
    }
  }
  elseif (!empty($definition['context_definitions'][$name])) {
    return $definition['context_definitions'][$name];
  }
  throw new ContextException(sprintf("The %s context is not a valid context.", $name));
}

---