trait ContextAwarePluginDefinitionTrait in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Component/Plugin/Definition/ContextAwarePluginDefinitionTrait.php \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionTrait
- 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
- trait \Drupal\Component\Plugin\Definition\ContextAwarePluginDefinitionTrait
4 files declare their use of ContextAwarePluginDefinitionTrait
- ContextAwarePluginTraitTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Plugin/ Context/ ContextAwarePluginTraitTest.php - ContextHandlerTest.php in core/
tests/ Drupal/ Tests/ Core/ Plugin/ ContextHandlerTest.php - Contains \Drupal\Tests\Core\Plugin\ContextHandlerTest.
- LayoutDefinition.php in core/
lib/ Drupal/ Core/ Layout/ LayoutDefinition.php - 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\DefinitionView 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;
}
}