You are here

public function ContextAwarePluginBase::setContext in Drupal 8

Same name in this branch
  1. 8 core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php \Drupal\Core\Plugin\ContextAwarePluginBase::setContext()
  2. 8 core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php \Drupal\Component\Plugin\ContextAwarePluginBase::setContext()

Set a context on this plugin.

Parameters

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

\Drupal\Component\Plugin\Context\ContextInterface $context: The context object to set.

Overrides ContextAwarePluginBase::setContext

3 calls to ContextAwarePluginBase::setContext()
ContextAwarePluginBase::setContextValue in core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php
Sets the value for a defined context.
DefaultsSectionStorage::setContext in core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php
Set a context on this plugin.
TestContextAwarePlugin::setContext in core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginBaseTest.php
Set a context on this plugin.
2 methods override ContextAwarePluginBase::setContext()
DefaultsSectionStorage::setContext in core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php
Set a context on this plugin.
TestContextAwarePlugin::setContext in core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginBaseTest.php
Set a context on this plugin.

File

core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php, line 61

Class

ContextAwarePluginBase
Base class for plugins that are context aware.

Namespace

Drupal\Core\Plugin

Code

public function setContext($name, ComponentContextInterface $context) {

  // Check that the context passed is an instance of our extended interface.
  if (!$context instanceof ContextInterface) {
    throw new ContextException("Passed {$name} context must be an instance of \\Drupal\\Core\\Plugin\\Context\\ContextInterface");
  }
  parent::setContext($name, $context);
}