Skip to content
This repository has been archived by the owner on Jan 29, 2020. It is now read-only.

Commit

Permalink
Merged from zf2/master
Browse files Browse the repository at this point in the history
  • Loading branch information
@ezimuel
ezimuel committed Mar 27, 2012
35 parents 891fbf7 + 83d5b01 + 4579f15 + c86ed1e + 16b8f20 + 83086b6 + a81c8a5 + a85d989 + 55ef06c + a2d63b1 + 8210d1d + 0a08fc0 + 7d37340 + ab0ab2a + b9e0b9b + e1d4bda + e251276 + 161ba87 + f10c77c + 58cc6ef + cecfbb0 + c165fb8 + 1febb29 + 3325e48 + 8b68fab + 5859e98 + d34ef1c + e06dc2f + 4907ff6 + fd0e0ba + 43c1b37 + ec52465 + 2904103 + e4d7a5a + be7b13f commit 197a891
Show file tree
Hide file tree
Showing 23 changed files with 355 additions and 109 deletions.
4 changes: 2 additions & 2 deletions src/Event.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

Expand All @@ -33,7 +33,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Event implements EventDescription
Expand Down
8 changes: 4 additions & 4 deletions src/EventCollection.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

Expand All @@ -30,7 +30,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
interface EventCollection
Expand Down Expand Up @@ -84,10 +84,10 @@ public function attach($event, $callback, $priority = 1);
/**
* Detach an event listener
*
* @param CallbackHandler $listener
* @param CallbackHandler|ListenerAggregate $listener
* @return void
*/
public function detach(CallbackHandler $listener);
public function detach($listener);

/**
* Get a list of events for which this collection has listeners
Expand Down
4 changes: 2 additions & 2 deletions src/EventDescription.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

Expand All @@ -28,7 +28,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
interface EventDescription
Expand Down
182 changes: 126 additions & 56 deletions src/EventManager.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

Expand All @@ -38,7 +38,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class EventManager implements EventCollection
Expand Down Expand Up @@ -122,8 +122,8 @@ public function getStaticConnections()
}

/**
* Get the identifier(s) for this EventManager
*
* Get the identifier(s) for this EventManager
*
* @return array
*/
public function getIdentifiers()
Expand All @@ -132,9 +132,9 @@ public function getIdentifiers()
}

/**
* Set the identifiers (overrides any currently set identifiers)
*
* @param string|int|array|Traversable $identifiers
* Set the identifiers (overrides any currently set identifiers)
*
* @param string|int|array|Traversable $identifiers
* @return ModuleManager
*/
public function setIdentifiers($identifiers)
Expand All @@ -148,9 +148,9 @@ public function setIdentifiers($identifiers)
}

/**
* Add some identifier(s) (appends to any currently set identifiers)
*
* @param string|int|array|Traversable $identifiers
* Add some identifier(s) (appends to any currently set identifiers)
*
* @param string|int|array|Traversable $identifiers
* @return ModuleManager
*/
public function addIdentifiers($identifiers)
Expand All @@ -171,7 +171,7 @@ public function addIdentifiers($identifiers)
* @param string $event
* @param string|object $target Object calling emit, or symbol describing target (such as static method name)
* @param array|ArrayAccess $argv Array of arguments; typically, should be associative
* @param null|callback $callback
* @param null|callback $callback
* @return ResponseCollection All listener return values
*/
public function trigger($event, $target = null, $argv = array(), $callback = null)
Expand All @@ -195,10 +195,8 @@ public function trigger($event, $target = null, $argv = array(), $callback = nul
$e->setParams($argv);
}

if (!$callback) {
$callback = function() {
return false;
};
if ($callback && !is_callable($callback)) {
throw new InvalidCallbackException('Invalid callback provided');
}

return $this->triggerListeners($event, $e, $callback);
Expand Down Expand Up @@ -256,17 +254,47 @@ public function triggerUntil($event, $target, $argv = null, $callback = null)
* executed. By default, this value is 1; however, you may set it for any
* integer value. Higher values have higher priority (i.e., execute first).
*
* @param string $event
* @param callback $callback PHP callback
* You can specify "*" for the event name. In such cases, the listener will
* be triggered for every event.
*
* @param string|array|ListenerAggregate $event An event or array of event names. If a ListenerAggregate, proxies to {@link attachAggregate()}.
* @param callback|int $callback If string $event provided, expects PHP callback; for a ListenerAggregate $event, this will be the priority
* @param int $priority If provided, the priority at which to register the callback
* @return ListenerAggregate (to allow later unsubscribe)
* @return CallbackHandler|mixed CallbackHandler if attaching callback (to allow later unsubscribe); mixed if attaching aggregate
*/
public function attach($event, $callback, $priority = 1)
public function attach($event, $callback = null, $priority = 1)
{
// Proxy ListenerAggregate arguments to attachAggregate()
if ($event instanceof ListenerAggregate) {
return $this->attachAggregate($event, $callback);
}

// Null callback is invalid
if (null === $callback) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: expects a callback; none provided',
__METHOD__
));
}

// Array of events should be registered individually, and return an array of all listeners
if (is_array($event)) {
$listeners = array();
foreach ($event as $name) {
$listeners[] = $this->attach($name, $callback, $priority);
}
return $listeners;
}

// If we don't have a priority queue for the event yet, create one
if (empty($this->events[$event])) {
$this->events[$event] = new PriorityQueue();
}
$listener = new CallbackHandler($event, $callback, array('priority' => $priority));

// Create a callback handler, setting the event and priority in its metadata
$listener = new CallbackHandler($callback, array('event' => $event, 'priority' => $priority));

// Inject the callback handler into the queue
$this->events[$event]->insert($listener, $priority);
return $listener;
}
Expand All @@ -279,23 +307,37 @@ public function attach($event, $callback, $priority = 1)
* methods.
*
* @param ListenerAggregate $aggregate
* @param int $priority If provided, a suggested priority for the aggregate to use
* @return mixed return value of {@link ListenerAggregate::attach()}
*/
public function attachAggregate(ListenerAggregate $aggregate)
public function attachAggregate(ListenerAggregate $aggregate, $priority = 1)
{
return $aggregate->attach($this);
return $aggregate->attach($this, $priority);
}

/**
* Unsubscribe a listener from an event
*
* @param CallbackHandler $listener
* @param CallbackHandler|ListenerAggregate $listener
* @return bool Returns true if event and listener found, and unsubscribed; returns false if either event or listener not found
* @throws Exception\InvalidArgumentException if invalid listener provided
*/
public function detach(CallbackHandler $listener)
public function detach($listener)
{
$event = $listener->getEvent();
if (empty($this->events[$event])) {
if ($listener instanceof ListenerAggregate) {
return $this->detachAggregate($listener);
}

if (!$listener instanceof CallbackHandler) {
throw new Exception\InvalidArgumentException(sprintf(
'%s: expected a ListenerAggregate or CallbackHandler; received "%s"',
__METHOD__,
(is_object($listener) ? get_class($listener) : gettype($listener))
));
}

$event = $listener->getMetadatum('event');
if (!$event || empty($this->events[$event])) {
return false;
}
$return = $this->events[$event]->remove($listener);
Expand Down Expand Up @@ -377,43 +419,43 @@ public function prepareArgs(array $args)
/**
* Trigger listeners
*
* Actual functionality for triggering listeners, to which both trigger() and triggerUntil()
* Actual functionality for triggering listeners, to which both trigger() and triggerUntil()
* delegate.
*
* @param string $event Event name
* @param EventDescription $e
* @param callback $callback
*
* @param string $event Event name
* @param EventDescription $e
* @param null|callback $callback
* @return ResponseCollection
*/
protected function triggerListeners($event, EventDescription $e, $callback)
protected function triggerListeners($event, EventDescription $e, $callback = null)
{
$responses = new ResponseCollection;

$listeners = clone $this->getListeners($event);
foreach ($this->getStaticListeners($event) as $listener) {
$priority = $listener->getOption('priority');
if (null === $priority) {
$priority = 1;
} elseif (is_array($priority)) {
// If we have an array, likely using PriorityQueue. Grab first
// element of the array, as that's the actual priority.
$priority = array_shift($priority);
}
$listeners->insert($listener, $priority);
$listeners = $this->getListeners($event);

// Add static/wildcard listeners to the list of listeners,
// but don't modify the listeners object
$staticListeners = $this->getStaticListeners($event);
$staticWildcardListeners = $this->getStaticListeners('*');
$wildcardListeners = $this->getListeners('*');
if (count($staticListeners) || count($staticWildcardListeners) || count($wildcardListeners)) {
$listeners = clone $listeners;
}

// Static listeners on this specific event
$this->insertListeners($listeners, $staticListeners);

// Static wildcard listeners
$this->insertListeners($listeners, $staticWildcardListeners);

// Add wildcard listeners
$this->insertListeners($listeners, $wildcardListeners);

if ($listeners->isEmpty()) {
return $responses;
}

foreach ($listeners as $listener) {
// If we have an invalid listener, detach it, and move on to the next
if (!$listener->isValid()) {
$this->detach($listener);
continue;
}

// Trigger the listener's callback, and push its result onto the
// Trigger the listener's callback, and push its result onto the
// response collection
$responses->push(call_user_func($listener->getCallback(), $e));

Expand All @@ -423,9 +465,9 @@ protected function triggerListeners($event, EventDescription $e, $callback)
break;
}

// If the result causes our validation callback to return true,
// If the result causes our validation callback to return true,
// stop propagation
if (call_user_func($callback, $responses->last())) {
if ($callback && call_user_func($callback, $responses->last())) {
$responses->setStopped(true);
break;
}
Expand All @@ -435,10 +477,10 @@ protected function triggerListeners($event, EventDescription $e, $callback)
}

/**
* Get list of all listeners attached to the static collection for
* Get list of all listeners attached to the static collection for
* identifiers registered by this instance
*
* @param string $event
*
* @param string $event
* @return array
*/
protected function getStaticListeners($event)
Expand Down Expand Up @@ -469,4 +511,32 @@ protected function getStaticListeners($event)

return $staticListeners;
}

/**
* Add listeners to the master queue of listeners
*
* Used to inject static listeners and wildcard listeners.
*
* @param PriorityQueue $masterListeners
* @param PriorityQueue $listeners
* @return void
*/
protected function insertListeners($masterListeners, $listeners)
{
if (!count($listeners)) {
return;
}

foreach ($listeners as $listener) {
$priority = $listener->getMetadatum('priority');
if (null === $priority) {
$priority = 1;
} elseif (is_array($priority)) {
// If we have an array, likely using PriorityQueue. Grab first
// element of the array, as that's the actual priority.
$priority = array_shift($priority);
}
$masterListeners->insert($listener, $priority);
}
}
}
4 changes: 2 additions & 2 deletions src/Exception.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/

Expand All @@ -28,7 +28,7 @@
*
* @category Zend
* @package Zend_EventManager
* @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
* @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
interface Exception
Expand Down
Loading

0 comments on commit 197a891

Please sign in to comment.