public function ContextAwarePluginBase::setContextValue in Zircon Profile 8

Same name in this branch

1. 8 core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php \Drupal\Core\Plugin\ContextAwarePluginBase::setContextValue()
2. 8 core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php \Drupal\Component\Plugin\ContextAwarePluginBase::setContextValue()

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php \Drupal\Component\Plugin\ContextAwarePluginBase::setContextValue()

Sets the value for a defined context.

Parameters

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

mixed $value: The value to set the context to. The value has to validate against the provided context definition.

Return value

\Drupal\Component\Plugin\ContextAwarePluginInterface. A context aware plugin object for chaining.

Throws

\Drupal\Component\Plugin\Exception\PluginException If the value does not pass validation.

Overrides ContextAwarePluginInterface::setContextValue

1 method overrides ContextAwarePluginBase::setContextValue()

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

Sets the value for a defined context.

File

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

Contains \Drupal\Component\Plugin\ContextAwarePluginBase.

Class

ContextAwarePluginBase

Base class for plugins that are context aware.

Namespace

Drupal\Component\Plugin

Code

public function setContextValue($name, $value) {
  $this->context[$name] = new Context($this
    ->getContextDefinition($name), $value);
  return $this;
}