1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 <?php
/*-----8<--------------------------------------------------------------------
*
* BEdita - a semantic content management framework
*
* Copyright 2014 ChannelWeb Srl, Chialab Srl
*
* This file is part of BEdita: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* BEdita is distributed WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with BEdita (see LICENSE.LGPL).
* If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
*
*------------------------------------------------------------------->8-----
*/
/**
* Basic event manager for BEdita.
*/
class BeCallbackManager {
/**
* Array of currently attached listeners.
*
* @var array
* @access protected
*/
protected $listeners = array();
/**
* Attaches a listener to an event.
*
* Listeners can be either anonymous functions or pairs of class name (or object instance) / method name
*
* @see self::callListener() to see valid types of listener
* @param string $eventName Name of the event to be listened.
* @param mixed $listener Callback or full qualified name of listener.
* @return boolean Success.
* @access public
*/
public function bind($eventName, $listener) {
if (!array_key_exists($eventName, $this->listeners)) {
$this->listeners[$eventName] = array();
}
array_push($this->listeners[$eventName], $listener);
return true;
}
/**
* Detaches a listener from an event.
*
* If `$eventName` is `null`, the given `$listener` will be detached from any event it was attached to.
* If `$listener` is `null`, all listeners binded to the given `$eventName` will be detached from that event.
* If both parameters are empty, each end every listener is cleared from any event.
*
* @param string $eventName Name of the event to be unbinded.
* @param mixed $listener Callback or full qualified name of callback.
* @return boolean Success.
* @access public
*/
public function unbind($eventName = null, $listener = null) {
if (!empty($eventName)) {
// Event name specified.
if (!array_key_exists($eventName, $this->listeners)) {
// No listeners binded to event.
return false;
}
if (empty($listener)) {
// Clear all listeners.
unset($this->listeners[$eventName]);
return true;
}
// Clear specified listener.
$key = array_search($listener, $this->listeners[$eventName]);
if ($key === false) {
return false;
}
unset($this->listeners[$eventName][$key]);
if (!count($this->listeners[$eventName])) {
unset($this->listeners[$eventName]);
}
return true;
}
if (!empty($listener)) {
// No event name specified, but specified listener.
foreach ($this->listeners as $eventName => $listeners) {
$key = array_search($listener, $this->listeners[$eventName]);
if ($key === false) {
continue;
}
unset($this->listeners[$eventName][$key]);
if (!count($this->listeners[$eventName])) {
unset($this->listeners[$eventName]);
}
}
return true;
}
// Reset all.
$this->listeners = array();
return true;
}
/**
* Triggers a new event, calling all listeners binded to that event in the order they were added.
*
* Passing data as an array will result in callbacks associated to the triggered event being called
* with array elements as arguments in the order they appear in that array.
* In addition to that, the `$event` object will be passed to those callbacks as *last* argument,
* thus allowing listeners to gain control on event propagation or modifying the event itself.
*
* To stop the event propagation the listener method can return `false`
* or use `$event->stopPropagation->__invoke()`
*
* @param string $eventName Name of the event to be triggered.
* @param array $eventData Data of the event.
* @return stdClass Class representing the event triggered, with `name`, `data`, `result` and `stopped` keys.
* @access public
*/
public function trigger($eventName, array $eventData = array()) {
$event = $this->initEvent($eventName, $eventData);
if (!array_key_exists($event->name, $this->listeners)) {
return $event;
}
foreach ($this->listeners[$event->name] as $listener) {
$event->result = $this->callListener(
$listener,
array_merge($event->data, array($event))
);
if ($event->result === false || !empty($event->stopped)) {
break;
}
}
return $event;
}
/**
* Check if $listener is valid and call it
* To be valid a listener must be:
*
* - a Closure
* - a string as `ClassName::methodName` (methodName should be static)
* - an array as `array(instance of a class, 'methodName')`
* - an array as `array('ClassName', 'methodName')`
* In this case:
* - if 'ClassName' is in the registry the instance is retrieved
* - else try to use it (methodName should be static)
*
* @throws BeditaInternalErrorException if the listener is not callable
* @param mixed $listener Callback or full qualified name of callback
* @return mixed the result of listener call
*/
private function callListener($listener, array $data = array()) {
if (is_array($listener)) {
list($class, $method) = $listener;
if (is_string($class) && ClassRegistry::isKeySet($class)) {
$listener = array(ClassRegistry::getObject($class), $method);
}
}
if (!is_callable($listener)) {
throw new BeditaInternalErrorException('Listener not callable: ' . print_r($listener, true));
}
return call_user_func_array($listener, $data);
}
/**
* Initializes a new event.
*
* @param string $eventName Event name.
* @param array $eventData Event data.
* @return stdClass Event.
* @access private
*/
private function initEvent($eventName, array $eventData) {
$event = new stdClass();
$event->name = $eventName;
$event->data = $eventData;
$event->stopPropagation = function() use ($event) {
$event->stopped = true;
};
$event->result = null;
return $event;
}
}