interface/modules/zend_modules/library/Zend/EventManager/GlobalEventManager.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\EventManager;
  11
  12 use Zend\Stdlib\CallbackHandler;
  13 use Zend\Stdlib\PriorityQueue;
  14
  15 /**
  16  * Event manager: notification system
  17  *
  18  * Use the EventManager when you want to create a per-instance notification
  19  * system for your objects.
  20  */
  21 class GlobalEventManager
  22 {
  23     /**
  24      * @var EventManagerInterface
  25      */
  26     protected static $events;
  27
  28     /**
  29      * Set the event collection on which this will operate
  30      *
  31      * @param  null|EventManagerInterface $events
  32      * @return void
  33      */
  34     public static function setEventCollection(EventManagerInterface $events = null)
  35     {
  36         static::$events = $events;
  37     }
  38
  39     /**
  40      * Get event collection on which this operates
  41      *
  42      * @return EventManagerInterface
  43      */
  44     public static function getEventCollection()
  45     {
  46         if (null === static::$events) {
  47             static::setEventCollection(new EventManager());
  48         }
  49         return static::$events;
  50     }
  51
  52     /**
  53      * Trigger an event
  54      *
  55      * @param  string $event
  56      * @param  object|string $context
  57      * @param  array|object $argv
  58      * @return ResponseCollection
  59      */
  60     public static function trigger($event, $context, $argv = array())
  61     {
  62         return static::getEventCollection()->trigger($event, $context, $argv);
  63     }
  64
  65     /**
  66      * Trigger listeners until return value of one causes a callback to evaluate
  67      * to true.
  68      *
  69      * @param  string $event
  70      * @param  string|object $context
  71      * @param  array|object $argv
  72      * @param  callable $callback
  73      * @return ResponseCollection
  74      */
  75     public static function triggerUntil($event, $context, $argv, $callback)
  76     {
  77         return static::getEventCollection()->triggerUntil($event, $context, $argv, $callback);
  78     }
  79
  80     /**
  81      * Attach a listener to an event
  82      *
  83      * @param  string $event
  84      * @param  callable $callback
  85      * @param  int $priority
  86      * @return CallbackHandler
  87      */
  88     public static function attach($event, $callback, $priority = 1)
  89     {
  90         return static::getEventCollection()->attach($event, $callback, $priority);
  91     }
  92
  93     /**
  94      * Detach a callback from a listener
  95      *
  96      * @param  CallbackHandler $listener
  97      * @return bool
  98      */
  99     public static function detach(CallbackHandler $listener)
 100     {
 101         return static::getEventCollection()->detach($listener);
 102     }
 103
 104     /**
 105      * Retrieve list of events this object manages
 106      *
 107      * @return array
 108      */
 109     public static function getEvents()
 110     {
 111         return static::getEventCollection()->getEvents();
 112     }
 113
 114     /**
 115      * Retrieve all listeners for a given event
 116      *
 117      * @param  string $event
 118      * @return PriorityQueue|array
 119      */
 120     public static function getListeners($event)
 121     {
 122         return static::getEventCollection()->getListeners($event);
 123     }
 124
 125     /**
 126      * Clear all listeners for a given event
 127      *
 128      * @param  string $event
 129      * @return void
 130      */
 131     public static function clearListeners($event)
 132     {
 133         static::getEventCollection()->clearListeners($event);
 134     }
 135 }