EventManager/ResponseCollection.php
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
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_EventManager
\SplStack
- Implements
- Children
- \Zend_EventManager_ResponseCollection
Constants
Properties
Methods


offsetExists(mixed $index) : bool
ArrayAccess: does an item exist at the specified offset?
Name | Type | Description |
---|---|---|
$index | mixed |
Type | Description |
---|---|
bool |


offsetGet(mixed $index) : mixed
ArrayAccess: get the item at the specified offset
Name | Type | Description |
---|---|---|
$index | mixed |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\OutOfRangeException |


offsetSet(mixed $index, mixed $newval) : void
ArrayAccess: add an item at the specified offset
Name | Type | Description |
---|---|---|
$index | mixed | |
$newval | mixed |


offsetUnset(mixed $index) : void
ArrayAccess: unset the item at the specified offset
Name | Type | Description |
---|---|---|
$index | mixed |
Exception | Description |
---|---|
\OutOfRangeException |


pop() : mixed
Pop a node from the end of the stack
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\RuntimeException |


setIteratorMode(int $mode) : void
Set the iterator mode
Must be set to one of IT_MODE_DELETE or IT_MODE_KEEP
Name | Type | Description |
---|---|---|
$mode | int |
Exception | Description |
---|---|
\InvalidArgumentException |
- Todo
- Currently, IteratorMode is ignored, as we use the default (keep); should this be implemented?


shift() : mixed
Shifts a node from the beginning of the list
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\RuntimeException |


unserialize(string $serialized) : void
Unserialize the storage
Name | Type | Description |
---|---|---|
$serialized | string |


unshift(mixed $value) : void
Unshift a node onto the beginning of the list
Name | Type | Description |
---|---|---|
$value | mixed |
\Zend_EventManager_ResponseCollection
- Parent(s)
- \SplStack
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Properties


int $mode = self::IT_MODE_KEEP
self::IT_MODE_KEEP
Details- Type
- int
- Inherited_from
- \SplStack::$$mode


false|array $stack = false
false
Details- Type
- false | array
- Inherited_from
- \SplStack::$$stack
Methods


contains(mixed $value) : void
Check if any of the responses match the given value.
Name | Type | Description |
---|---|---|
$value | mixed | The value to look for among responses |


first() : mixed
Convenient access to the first handler return value.
Type | Description |
---|---|
mixed | The first handler return value |


last() : mixed
Convenient access to the last handler return value.
If the collection is empty, returns null. Otherwise, returns value returned by last handler.
Type | Description |
---|---|
mixed | The last handler return value |


offsetExists(mixed $index) : bool
ArrayAccess: does an item exist at the specified offset?
Inherited from: \SplStack::offsetExists()Name | Type | Description |
---|---|---|
$index | mixed |
Type | Description |
---|---|
bool |


offsetGet(mixed $index) : mixed
Name | Type | Description |
---|---|---|
$index | mixed |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\OutOfRangeException |


offsetUnset(mixed $index) : void
ArrayAccess: unset the item at the specified offset
Inherited from: \SplStack::offsetUnset()Name | Type | Description |
---|---|---|
$index | mixed |
Exception | Description |
---|---|
\OutOfRangeException |


setIteratorMode(int $mode) : void
Must be set to one of IT_MODE_DELETE or IT_MODE_KEEP
Name | Type | Description |
---|---|---|
$mode | int |
Exception | Description |
---|---|
\InvalidArgumentException |


setStopped(bool $flag) : \Zend_EventManager_ResponseCollection
Mark the collection as stopped (or its opposite)
Name | Type | Description |
---|---|---|
$flag | bool |
Type | Description |
---|---|
\Zend_EventManager_ResponseCollection |


stopped() : bool
Did the last response provided trigger a short circuit of the stack?
Type | Description |
---|---|
bool |