You are here

trait ContextAwarePluginDefinitionTrait in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Component/Plugin/Definition/ContextAwarePluginDefinitionTrait.php \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionTrait

Provides a trait for context-aware object-based plugin definitions.

Hierarchy

3 files declare their use of ContextAwarePluginDefinitionTrait
ContextAwarePluginBaseTest.php in core/tests/Drupal/KernelTests/Core/Plugin/Context/ContextAwarePluginBaseTest.php
ContextHandlerTest.php in core/tests/Drupal/Tests/Core/Plugin/ContextHandlerTest.php
Contains \Drupal\Tests\Core\Plugin\ContextHandlerTest.
SectionStorageDefinition.php in core/modules/layout_builder/src/SectionStorage/SectionStorageDefinition.php

File

core/lib/Drupal/Component/Plugin/Definition/ContextAwarePluginDefinitionTrait.php, line 11

Namespace

Drupal\Component\Plugin\Definition
View source
trait ContextAwarePluginDefinitionTrait {

  /**
   * The context definitions for this plugin definition.
   *
   * @var \Drupal\Component\Plugin\Context\ContextDefinitionInterface[]
   */
  protected $contextDefinitions = [];

  /**
   * Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::hasContextDefinition().
   */
  public function hasContextDefinition($name) {
    return array_key_exists($name, $this->contextDefinitions);
  }

  /**
   * Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinitions().
   */
  public function getContextDefinitions() {
    return $this->contextDefinitions;
  }

  /**
   * Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::getContextDefinition().
   */
  public function getContextDefinition($name) {
    if ($this
      ->hasContextDefinition($name)) {
      return $this->contextDefinitions[$name];
    }
    throw new ContextException($this
      ->id() . " does not define a '{$name}' context");
  }

  /**
   * Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::addContextDefinition().
   */
  public function addContextDefinition($name, ContextDefinitionInterface $definition) {
    $this->contextDefinitions[$name] = $definition;
    return $this;
  }

  /**
   * Implements \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionInterface::removeContextDefinition().
   */
  public function removeContextDefinition($name) {
    unset($this->contextDefinitions[$name]);
    return $this;
  }

}

Members