function ContextAwarePluginBase::setContextValue

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php \Drupal\Core\Plugin\ContextAwarePluginBase::setContextValue()
  2. 8.9.x 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

$this A context aware plugin object for chaining.

Overrides ContextAwarePluginInterface::setContextValue

File

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

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;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.