[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Zend Framework (http://framework.zend.com/)
   4   *
   5   * @link      http://github.com/zendframework/zend-eventmanager for the canonical source repository
   6   * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7   * @license   https://github.com/zendframework/zend-eventmanager/blob/master/LICENSE.md
   8   */
   9  
  10  namespace Zend\EventManager;
  11  
  12  /**
  13   * Interface for shared event listener collections
  14   */
  15  interface SharedEventManagerInterface
  16  {
  17      /**
  18       * Attach a listener to an event emitted by components with specific identifiers.
  19       *
  20       * @param  string $identifier Identifier for event emitting component
  21       * @param  string $eventName
  22       * @param  callable $listener Listener that will handle the event.
  23       * @param  int $priority Priority at which listener should execute
  24       */
  25      public function attach($identifier, $eventName, callable $listener, $priority = 1);
  26  
  27      /**
  28       * Detach a shared listener.
  29       *
  30       * Allows detaching a listener from one or more events to which it may be
  31       * attached.
  32       *
  33       * @param  callable $listener Listener to detach.
  34       * @param  null|string $identifier Identifier from which to detach; null indicates
  35       *      all registered identifiers.
  36       * @param  null|string $eventName Event from which to detach; null indicates
  37       *      all registered events.
  38       * @throws Exception\InvalidArgumentException for invalid identifier arguments.
  39       * @throws Exception\InvalidArgumentException for invalid event arguments.
  40       */
  41      public function detach(callable $listener, $identifier = null, $eventName = null);
  42  
  43      /**
  44       * Retrieve all listeners for given identifiers
  45       *
  46       * @param  array $identifiers
  47       * @param  string $eventName
  48       * @return array
  49       */
  50      public function getListeners(array $identifiers, $eventName);
  51  
  52      /**
  53       * Clear all listeners for a given identifier, optionally for a specific event
  54       *
  55       * @param  string $identifier
  56       * @param  null|string $eventName
  57       */
  58      public function clearListeners($identifier, $eventName = null);
  59  }