You are here

final class GatheringPluginInfoEvent in Search API 8

Wraps a gathering of plugin information event.

Hierarchy

Expanded class hierarchy of GatheringPluginInfoEvent

2 files declare their use of GatheringPluginInfoEvent
EventListener.php in tests/search_api_test_events/src/EventListener.php
SearchApiPluginManager.php in src/SearchApiPluginManager.php

File

src/Event/GatheringPluginInfoEvent.php, line 10

Namespace

Drupal\search_api\Event
View source
final class GatheringPluginInfoEvent extends Event {

  /**
   * The plugin definitions.
   *
   * @var array[]
   */
  protected $definitions;

  /**
   * Constructs a new class instance.
   *
   * @param array[] $definitions
   *   The plugin definitions collected so far, keyed by plugin ID.
   */
  public function __construct(array &$definitions) {
    $this->definitions =& $definitions;
  }

  /**
   * Retrieves the plugin definitions collected so far.
   *
   * @return array[]
   *   The plugin definitions collected so far, keyed by plugin ID.
   */
  public function &getDefinitions() {
    return $this->definitions;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
GatheringPluginInfoEvent::$definitions protected property The plugin definitions.
GatheringPluginInfoEvent::getDefinitions public function Retrieves the plugin definitions collected so far.
GatheringPluginInfoEvent::__construct public function Constructs a new class instance.