You are here

class InfoHookDecorator in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Plugin/Discovery/InfoHookDecorator.php \Drupal\Core\Plugin\Discovery\InfoHookDecorator
  2. 10 core/lib/Drupal/Core/Plugin/Discovery/InfoHookDecorator.php \Drupal\Core\Plugin\Discovery\InfoHookDecorator

Allows info hook implementations to enhance discovered plugin definitions.

Hierarchy

Expanded class hierarchy of InfoHookDecorator

1 file declares its use of InfoHookDecorator
ConfigMapperManager.php in core/modules/config_translation/src/ConfigMapperManager.php

File

core/lib/Drupal/Core/Plugin/Discovery/InfoHookDecorator.php, line 11

Namespace

Drupal\Core\Plugin\Discovery
View source
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;
  }

  /**
   * {@inheritdoc}
   */
  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([
      $this->decorated,
      $method,
    ], $args);
  }

}

Members

Namesort descending 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 Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions
InfoHookDecorator::__call public function Passes through all unknown calls onto the decorated object.
InfoHookDecorator::__construct public function Constructs a InfoHookDecorator object.