File indexing completed on 2024-05-12 06:02:28

 <?php
 /**
  * Zend Framework
  *
  * LICENSE
  *
  * This source file is subject to the new BSD license that is bundled
  * with this package in the file LICENSE.txt.
  * It is also available through the world-wide-web at this URL:
  * http://framework.zend.com/license/new-bsd
  * If you did not receive a copy of the license and are unable to
  * obtain it through the world-wide-web, please send an email
  * to license@zend.com so we can send you a copy immediately.
  *
  * @category   Zend
  * @package    Zend_EventManager
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 
 // require_once 'Zend/Stdlib/CallbackHandler.php';
 
 /**
  * Interface for messengers
  *
  * @category   Zend
  * @package    Zend_EventManager
  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  */
 interface Zend_EventManager_EventCollection
 {
     /**
      * Trigger an event
      *
      * Should allow handling the following scenarios:
      * - Passing Event object only
      * - Passing event name and Event object only
      * - Passing event name, target, and Event object
      * - Passing event name, target, and array|ArrayAccess of arguments
      *
      * Can emulate triggerUntil() if the last argument provided is a callback.
      * 
      * @param  string $event 
      * @param  object|string $target 
      * @param  array|object $argv 
      * @param  null|callback $callback 
      * @return Zend_EventManager_ResponseCollection
      */
     public function trigger($event, $target = null, $argv = array(), $callback = null);
 
     /**
      * Trigger an event until the given callback returns a boolean false
      *
      * Should allow handling the following scenarios:
      * - Passing Event object and callback only
      * - Passing event name, Event object, and callback only
      * - Passing event name, target, Event object, and callback
      * - Passing event name, target, array|ArrayAccess of arguments, and callback
      * 
      * @param  string $event 
      * @param  object|string $target 
      * @param  array|object $argv 
      * @param  callback $callback 
      * @return Zend_EventManager_ResponseCollection
      */
     public function triggerUntil($event, $target, $argv = null, $callback = null);
 
     /**
      * Attach a listener to an event
      * 
      * @param  string $event 
      * @param  callback $callback
      * @param  int $priority Priority at which to register listener
      * @return Zend_Stdlib_CallbackHandler
      */
     public function attach($event, $callback = null, $priority = 1);
 
     /**
      * Detach an event listener
      * 
      * @param  Zend_Stdlib_CallbackHandler|Zend_EventManager_ListenerAggregate $listener 
      * @return void
      */
     public function detach($listener);
 
     /**
      * Get a list of events for which this collection has listeners
      * 
      * @return array
      */
     public function getEvents();
 
     /**
      * Retrieve a list of listeners registered to a given event
      * 
      * @param  string $event 
      * @return array|object
      */
     public function getListeners($event);
 
     /**
      * Clear all listeners for a given event
      * 
      * @param  string $event 
      * @return void
      */
     public function clearListeners($event);
 }