[Summary view] [Print] [Text view]

   1  <?php
   2  namespace GuzzleHttp\Event;
   3  
   4  /**
   5   * SubscriberInterface provides an array of events to an
   6   * EventEmitterInterface when it is registered. The emitter then binds the
   7   * listeners specified by the EventSubscriber.
   8   *
   9   * This interface is based on the SubscriberInterface of the Symfony.
  10   * @link https://github.com/symfony/symfony/tree/master/src/Symfony/Component/EventDispatcher
  11   */
  12  interface SubscriberInterface
  13  {
  14      /**
  15       * Returns an array of event names this subscriber wants to listen to.
  16       *
  17       * The returned array keys MUST map to an event name. Each array value
  18       * MUST be an array in which the first element is the name of a function
  19       * on the EventSubscriber OR an array of arrays in the aforementioned
  20       * format. The second element in the array is optional, and if specified,
  21       * designates the event priority.
  22       *
  23       * For example, the following are all valid:
  24       *
  25       *  - ['eventName' => ['methodName']]
  26       *  - ['eventName' => ['methodName', $priority]]
  27       *  - ['eventName' => [['methodName'], ['otherMethod']]
  28       *  - ['eventName' => [['methodName'], ['otherMethod', $priority]]
  29       *  - ['eventName' => [['methodName', $priority], ['otherMethod', $priority]]
  30       *
  31       * @return array
  32       */
  33      public function getEvents();
  34  }