EventManager/EventCollection.php
inheritedLICENSE
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
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_EventManager
\Zend_EventManager_EventCollection
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
attach(string $event, callback $callback = null, int $priority = 1) : \Zend_Stdlib_CallbackHandlerAttach a listener to an event
| Name | Type | Description |
|---|---|---|
| $event | string | |
| $callback | callback | |
| $priority | int | Priority at which to register listener |
| Type | Description |
|---|---|
| \Zend_Stdlib_CallbackHandler |
clearListeners(string $event) : voidClear all listeners for a given event
| Name | Type | Description |
|---|---|---|
| $event | string |
detach(\Zend_Stdlib_CallbackHandler | \Zend_EventManager_ListenerAggregate $listener) : voidDetach an event listener
| Name | Type | Description |
|---|---|---|
| $listener | \Zend_Stdlib_CallbackHandler | \Zend_EventManager_ListenerAggregate |
getEvents() : arrayGet a list of events for which this collection has listeners
| Type | Description |
|---|---|
| array |
getListeners(string $event) : array | objectRetrieve a list of listeners registered to a given event
| Name | Type | Description |
|---|---|---|
| $event | string |
| Type | Description |
|---|---|
| array | object |
trigger(string $event, object | string $target = null, array | object $argv = array(), null | callback $callback = null) : \Zend_EventManager_ResponseCollectionTrigger 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.
| Name | Type | Description |
|---|---|---|
| $event | string | |
| $target | object | string | |
| $argv | array | object | |
| $callback | null | callback |
| Type | Description |
|---|---|
| \Zend_EventManager_ResponseCollection |
triggerUntil(string $event, object | string $target, array | object $argv = null, callback $callback = null) : \Zend_EventManager_ResponseCollectionTrigger 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
| Name | Type | Description |
|---|---|---|
| $event | string | |
| $target | object | string | |
| $argv | array | object | |
| $callback | callback |
| Type | Description |
|---|---|
| \Zend_EventManager_ResponseCollection |