Enables altering of discovered plugin definitions.
Expanded class hierarchy of AlterDecorator
class AlterDecorator implements DiscoveryInterface {
/**
* The name of the alter hook that will be implemented by this discovery instance.
*
* @var string
*/
protected $hook;
/**
* The Discovery object being decorated.
*
* @var Drupal\Component\Plugin\Discovery\DiscoveryInterface
*/
protected $decorated;
/**
* Constructs a Drupal\Core\Plugin\Discovery\AlterDecorator object.
*
* It uses the DiscoveryInterface object it should decorate.
*
* @param Drupal\Component\Plugin\Discovery\DiscoveryInterface $decorated
* The object implementing DiscoveryInterface that is being decorated.
* @param string $hook
* The name of the alter hook that will be used by this discovery instance.
*/
public function __construct(DiscoveryInterface $decorated, $hook) {
$this->decorated = $decorated;
$this->hook = $hook;
}
/**
* Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinition().
*/
public function getDefinition($plugin_id) {
$definitions = $this
->getDefinitions();
return isset($definitions[$plugin_id]) ? $definitions[$plugin_id] : NULL;
}
/**
* Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinitions().
*/
public function getDefinitions() {
$definitions = $this->decorated
->getDefinitions();
drupal_alter($this->hook, $definitions);
return $definitions;
}
/**
* Passes through all unknown calls onto the decorated object.
*/
public function __call($method, $args) {
return call_user_func_array(array(
$this->decorated,
$method,
), $args);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AlterDecorator:: |
protected | property | The Discovery object being decorated. | |
AlterDecorator:: |
protected | property | The name of the alter hook that will be implemented by this discovery instance. | |
AlterDecorator:: |
public | function |
Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinition(). Overrides DiscoveryInterface:: |
|
AlterDecorator:: |
public | function |
Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinitions(). Overrides DiscoveryInterface:: |
|
AlterDecorator:: |
public | function | Passes through all unknown calls onto the decorated object. | |
AlterDecorator:: |
public | function | Constructs a Drupal\Core\Plugin\Discovery\AlterDecorator object. |