ContextAwarePluginBase.php

1. 8.x drupal/core/lib/Drupal/Core/Plugin/ContextAwarePluginBase.php
2. 8.x drupal/core/lib/Drupal/Component/Plugin/ContextAwarePluginBase.php

<?php

/**
 * @file
 * Contains \Drupal\Core\Plugin\ContextAwarePluginBase
 */
namespace Drupal\Core\Plugin;

use Drupal\Component\Plugin\ContextAwarePluginBase as PluginBase;
use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\Core\Plugin\Context\Context;
use Drupal\Component\Plugin\Discovery\DiscoveryInterface;

/**
 * Drupal specific class for plugins that use context.
 *
 * This class specifically overrides setContextValue to use the core version of
 * the Context class. This code is exactly the same as what is in Component
 * ContextAwarePluginBase but it is using a different Context class.
 */
abstract class ContextAwarePluginBase extends PluginBase {

  /**
   * Override of \Drupal\Component\Plugin\ContextAwarePluginBase::__construct().
   */
  public function __construct(array $configuration, $plugin_id, array $plugin_definition) {
    $context = array();
    if (isset($configuration['context'])) {
      $context = $configuration['context'];
      unset($configuration['context']);
    }
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    foreach ($context as $key => $value) {
      $context_definition = $this
        ->getContextDefinition($key);
      $this->context[$key] = new Context($context_definition);
      $this->context[$key]
        ->setContextValue($value);
    }
  }

  /**
   * Override of \Drupal\Component\Plugin\ContextAwarePluginBase::setContextValue().
   */
  public function setContextValue($name, $value) {
    $context_definition = $this
      ->getContextDefinition($name);

    // Use the Drupal specific context class.
    $this->context[$name] = new Context($context_definition);
    $this->context[$name]
      ->setContextValue($value);

    // Verify the provided value validates.
    if ($this->context[$name]
      ->validate()
      ->count() > 0) {
      throw new PluginException("The provided context value does not pass validation.");
    }
    return $this;
  }

}