class InfoHookDecorator in Plug 7

Allows info hook implementations to enhance discovered plugin definitions.

Hierarchy

• class \Drupal\Core\Plugin\Discovery\InfoHookDecorator implements DiscoveryInterface uses DiscoveryTrait

File

lib/Drupal/Core/Plugin/Discovery/InfoHookDecorator.php, line 16

Contains \Drupal\Core\Plugin\Discovery\InfoHookDecorator.

Namespace

Drupal\Core\Plugin\Discovery

class InfoHookDecorator implements DiscoveryInterface {
  use DiscoveryTrait;

  /**
   * The Discovery object being decorated.
   *
   * @var \Drupal\Component\Plugin\Discovery\DiscoveryInterface
   */
  protected $decorated;

  /**
   * The name of the info hook that will be implemented by this discovery instance.
   *
   * @var string
   */
  protected $hook;

  /**
   * Constructs a InfoHookDecorator object.
   *
   * @param \Drupal\Component\Plugin\Discovery\DiscoveryInterface $decorated
   *   The object implementing DiscoveryInterface that is being decorated.
   * @param string $hook
   *   The name of the info hook to be invoked by this discovery instance.
   */
  public function __construct(DiscoveryInterface $decorated, $hook) {
    $this->decorated = $decorated;
    $this->hook = $hook;
  }

  /**
   * Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinitions().
   */
  public function getDefinitions() {
    $definitions = $this->decorated
      ->getDefinitions();
    foreach (\Drupal::moduleHandler()
      ->getImplementations($this->hook) as $module) {
      $function = $module . '_' . $this->hook;
      $function($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);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::getDefinition	public	function		3
DiscoveryTrait::hasDefinition	public	function
InfoHookDecorator::$decorated	protected	property	The Discovery object being decorated.
InfoHookDecorator::$hook	protected	property	The name of the info hook that will be implemented by this discovery instance.
InfoHookDecorator::getDefinitions	public	function	Implements Drupal\Component\Plugin\Discovery\DiscoveryInterface::getDefinitions(). Overrides DiscoveryTrait::getDefinitions
InfoHookDecorator::__call	public	function	Passes through all unknown calls onto the decorated object.
InfoHookDecorator::__construct	public	function	Constructs a InfoHookDecorator object.