Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Component\Plugin;
Chris@0: 
Chris@0: use Drupal\Component\Plugin\Context\ContextInterface;
Chris@17: use Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface;
Chris@0: use Drupal\Component\Plugin\Exception\ContextException;
Chris@0: use Drupal\Component\Plugin\Context\Context;
Chris@0: use Symfony\Component\Validator\ConstraintViolationList;
Chris@0: 
Chris@0: /**
Chris@0:  * Base class for plugins that are context aware.
Chris@0:  */
Chris@0: abstract class ContextAwarePluginBase extends PluginBase implements ContextAwarePluginInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * The data objects representing the context of this plugin.
Chris@0:    *
Chris@0:    * @var \Drupal\Component\Plugin\Context\ContextInterface[]
Chris@0:    */
Chris@0:   protected $context = [];
Chris@0: 
Chris@0:   /**
Chris@0:    * Overrides \Drupal\Component\Plugin\PluginBase::__construct().
Chris@0:    *
Chris@0:    * Overrides the construction of context aware plugins to allow for
Chris@0:    * unvalidated constructor based injection of contexts.
Chris@0:    *
Chris@0:    * @param array $configuration
Chris@0:    *   The plugin configuration, i.e. an array with configuration values keyed
Chris@0:    *   by configuration option name. The special key 'context' may be used to
Chris@0:    *   initialize the defined contexts by setting it to an array of context
Chris@0:    *   values keyed by context names.
Chris@0:    * @param string $plugin_id
Chris@0:    *   The plugin_id for the plugin instance.
Chris@0:    * @param mixed $plugin_definition
Chris@0:    *   The plugin implementation definition.
Chris@0:    */
Chris@0:   public function __construct(array $configuration, $plugin_id, $plugin_definition) {
Chris@0:     $context_configuration = isset($configuration['context']) ? $configuration['context'] : [];
Chris@0:     unset($configuration['context']);
Chris@0: 
Chris@0:     parent::__construct($configuration, $plugin_id, $plugin_definition);
Chris@0: 
Chris@0:     $this->contexts = $this->createContextFromConfiguration($context_configuration);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Creates context objects from any context mappings in configuration.
Chris@0:    *
Chris@0:    * @param array $context_configuration
Chris@0:    *   An associative array of context names and values.
Chris@0:    *
Chris@0:    * @return \Drupal\Component\Plugin\Context\ContextInterface[]
Chris@0:    *   An array of context objects.
Chris@0:    */
Chris@0:   protected function createContextFromConfiguration(array $context_configuration) {
Chris@0:     $contexts = [];
Chris@0:     foreach ($context_configuration as $key => $value) {
Chris@0:       $context_definition = $this->getContextDefinition($key);
Chris@0:       $contexts[$key] = new Context($context_definition, $value);
Chris@0:     }
Chris@0:     return $contexts;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextDefinitions() {
Chris@0:     $definition = $this->getPluginDefinition();
Chris@17:     if ($definition instanceof ContextAwarePluginDefinitionInterface) {
Chris@17:       return $definition->getContextDefinitions();
Chris@17:     }
Chris@17:     else {
Chris@18:       return !empty($definition['context_definitions']) ? $definition['context_definitions'] : [];
Chris@17:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextDefinition($name) {
Chris@0:     $definition = $this->getPluginDefinition();
Chris@17:     if ($definition instanceof ContextAwarePluginDefinitionInterface) {
Chris@17:       if ($definition->hasContextDefinition($name)) {
Chris@17:         return $definition->getContextDefinition($name);
Chris@17:       }
Chris@0:     }
Chris@18:     elseif (!empty($definition['context_definitions'][$name])) {
Chris@18:       return $definition['context_definitions'][$name];
Chris@17:     }
Chris@17:     throw new ContextException(sprintf("The %s context is not a valid context.", $name));
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContexts() {
Chris@0:     // Make sure all context objects are initialized.
Chris@0:     foreach ($this->getContextDefinitions() as $name => $definition) {
Chris@0:       $this->getContext($name);
Chris@0:     }
Chris@0:     return $this->context;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContext($name) {
Chris@0:     // Check for a valid context value.
Chris@0:     if (!isset($this->context[$name])) {
Chris@0:       $this->context[$name] = new Context($this->getContextDefinition($name));
Chris@0:     }
Chris@0:     return $this->context[$name];
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setContext($name, ContextInterface $context) {
Chris@0:     $this->context[$name] = $context;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextValues() {
Chris@0:     $values = [];
Chris@0:     foreach ($this->getContextDefinitions() as $name => $definition) {
Chris@0:       $values[$name] = isset($this->context[$name]) ? $this->context[$name]->getContextValue() : NULL;
Chris@0:     }
Chris@0:     return $values;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function getContextValue($name) {
Chris@0:     return $this->getContext($name)->getContextValue();
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function setContextValue($name, $value) {
Chris@0:     $this->context[$name] = new Context($this->getContextDefinition($name), $value);
Chris@0:     return $this;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * {@inheritdoc}
Chris@0:    */
Chris@0:   public function validateContexts() {
Chris@0:     $violations = new ConstraintViolationList();
Chris@0:     // @todo: Implement symfony validator API to let the validator traverse
Chris@0:     // and set property paths accordingly.
Chris@0: 
Chris@0:     foreach ($this->getContexts() as $context) {
Chris@0:       $violations->addAll($context->validate());
Chris@0:     }
Chris@0:     return $violations;
Chris@0:   }
Chris@0: 
Chris@0: }