GatheringPluginInfoEvent.php in Search API 8

Namespace

Drupal\search_api\Event

File

src/Event/GatheringPluginInfoEvent.php

<?php

namespace Drupal\search_api\Event;

use Symfony\Component\EventDispatcher\Event;

/**
 * Wraps a gathering of plugin information event.
 */
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;
  }

}

Classes

Name	Description
GatheringPluginInfoEvent	Wraps a gathering of plugin information event.