trait PluginContextDefinitionTrait in Plugin 8.2
Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface.
Hierarchy
- trait \Drupal\plugin\PluginDefinition\PluginContextDefinitionTrait
1 file declares its use of PluginContextDefinitionTrait
- PluginContextDefinitionTraitTest.php in tests/
src/ Unit/ PluginDefinition/ PluginContextDefinitionTraitTest.php
File
- src/
PluginDefinition/ PluginContextDefinitionTrait.php, line 12
Namespace
Drupal\plugin\PluginDefinitionView source
trait PluginContextDefinitionTrait {
/**
* The context definitions.
*
* @var \Drupal\Component\Plugin\Context\ContextDefinitionInterface[]
*/
protected $contextDefinitions = [];
/**
* Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::setContextDefinitions().
*/
public function setContextDefinitions(array $context_definitions) {
PluginDefinitionValidator::validateContextDefinitions($context_definitions);
$this->contextDefinitions = $context_definitions;
return $this;
}
/**
* Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::getContextDefinitions().
*/
public function getContextDefinitions() {
return $this->contextDefinitions;
}
/**
* Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::setContextDefinition().
*/
public function setContextDefinition($name, ContextDefinitionInterface $context_definition) {
$this->contextDefinitions[$name] = $context_definition;
return $this;
}
/**
* Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::getContextDefinition().
*/
public function getContextDefinition($name) {
if (!$this
->hasContextDefinition($name)) {
throw new \InvalidArgumentException(sprintf('Context %s does not exist.', $name));
}
return $this->contextDefinitions[$name];
}
/**
* Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::hasContextDefinition().
*/
public function hasContextDefinition($name) {
return isset($this->contextDefinitions[$name]);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginContextDefinitionTrait:: |
protected | property | The context definitions. | |
PluginContextDefinitionTrait:: |
public | function | Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::getContextDefinition(). | |
PluginContextDefinitionTrait:: |
public | function | Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::getContextDefinitions(). | |
PluginContextDefinitionTrait:: |
public | function | Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::hasContextDefinition(). | |
PluginContextDefinitionTrait:: |
public | function | Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::setContextDefinition(). | |
PluginContextDefinitionTrait:: |
public | function | Implements \Drupal\Component\Plugin\PluginContextDefinitionInterface::setContextDefinitions(). |