EventManager/ResponseCollection.php
inherited
Classes
Zend Framework
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 [email protected] 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
int $count = 0Count of elements in the stack
0Details- Type
- int
array $data = array()Data represented by this stack
array()Details- Type
- array
int $mode = self::IT_MODE_KEEPMode used when iterating
self::IT_MODE_KEEPDetails- Type
- int
false|array $stack = falseSorted stack of values
falseDetails- Type
- false | array
Methods
bottom() : mixedReturn last element in the stack
| Type | Description |
|---|---|
| mixed |
count() : intCountable: return count of items in the stack
| Type | Description |
|---|---|
| int |
current() : mixedIterator: return current item in the stack
| Type | Description |
|---|---|
| mixed |
getIteratorMode() : intGet iteration mode
| Type | Description |
|---|---|
| int |
isEmpty() : boolIs the stack empty?
| Type | Description |
|---|---|
| bool |
key() : mixedIterator: return key of current item in the stack
| Type | Description |
|---|---|
| mixed |
next() : voidIterator: advance pointer to next item in the stack
offsetExists(mixed $index) : boolArrayAccess: does an item exist at the specified offset?
| Name | Type | Description |
|---|---|---|
| $index | mixed |
| Type | Description |
|---|---|
| bool |
offsetGet(mixed $index) : mixedArrayAccess: get the item at the specified offset
| Name | Type | Description |
|---|---|---|
| $index | mixed |
| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \OutOfRangeException |
offsetSet(mixed $index, mixed $newval) : voidArrayAccess: add an item at the specified offset
| Name | Type | Description |
|---|---|---|
| $index | mixed | |
| $newval | mixed |
offsetUnset(mixed $index) : voidArrayAccess: unset the item at the specified offset
| Name | Type | Description |
|---|---|---|
| $index | mixed |
| Exception | Description |
|---|---|
| \OutOfRangeException |
pop() : mixedPop a node from the end of the stack
| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \RuntimeException |
prev() : voidMove the iterator to the previous node
- Todo
- Does this need to be implemented?
push(mixed $value) : voidPush an element to the list
| Name | Type | Description |
|---|---|---|
| $value | mixed |
rewind() : voidIterator: rewind to beginning of stack
serialize() : stringSerialize the storage
| Type | Description |
|---|---|
| string |
setIteratorMode(int $mode) : voidSet 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() : mixedShifts a node from the beginning of the list
| Type | Description |
|---|---|
| mixed |
| Exception | Description |
|---|---|
| \RuntimeException |
top() : mixedPeek at the top node of the stack
| Type | Description |
|---|---|
| mixed |
unserialize( $serialized) : voidUnserialize the storage
| Name | Type | Description |
|---|---|---|
| $serialized | string |
unshift(mixed $value) : voidUnshift a node onto the beginning of the list
| Name | Type | Description |
|---|---|---|
| $value | mixed |
valid() : boolIterator: is the current pointer valid?
| Type | Description |
|---|---|
| bool |
\Zend_EventManager_ResponseCollection
Collection of signal handler return values
- 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_KEEPDetails- Type
- int
- Inherited_from
- \SplStack::$$mode
false|array $stack = false
falseDetails- Type
- false | array
- Inherited_from
- \SplStack::$$stack
$stopped = false
falseDetails- Type
- n/a
Methods
bottom() : mixed
| Type | Description |
|---|---|
| mixed |
contains(mixed $value) : voidCheck if any of the responses match the given value.
| Name | Type | Description |
|---|---|---|
| $value | mixed | The value to look for among responses |
count() : int
| Type | Description |
|---|---|
| int |
current() : mixed
| Type | Description |
|---|---|
| mixed |
first() : mixedConvenient access to the first handler return value.
| Type | Description |
|---|---|
| mixed | The first handler return value |
getIteratorMode() : int
| Type | Description |
|---|---|
| int |
isEmpty() : bool
| Type | Description |
|---|---|
| bool |
key() : mixed
| Type | Description |
|---|---|
| mixed |
last() : mixedConvenient 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 |
next() : void
offsetExists(mixed $index) : boolArrayAccess: 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 |
offsetSet(mixed $index, mixed $newval) : void
| Name | Type | Description |
|---|---|---|
| $index | mixed | |
| $newval | mixed |
offsetUnset(mixed $index) : voidArrayAccess: unset the item at the specified offset
Inherited from: \SplStack::offsetUnset()| Name | Type | Description |
|---|---|---|
| $index | mixed |
| Exception | Description |
|---|---|
| \OutOfRangeException |
push(mixed $value) : void
| Name | Type | Description |
|---|---|---|
| $value | mixed |
serialize() : string
| Type | Description |
|---|---|
| string |
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_ResponseCollectionMark the collection as stopped (or its opposite)
| Name | Type | Description |
|---|---|---|
| $flag | bool |
| Type | Description |
|---|---|
| \Zend_EventManager_ResponseCollection |
stopped() : boolDid the last response provided trigger a short circuit of the stack?
| Type | Description |
|---|---|
| bool |
top() : mixed
| Type | Description |
|---|---|
| mixed |
unserialize( $serialized) : void
| Name | Type | Description |
|---|---|---|
| $serialized | string |
unshift(mixed $value) : void
| Name | Type | Description |
|---|---|---|
| $value | mixed |
valid() : bool
| Type | Description |
|---|---|
| bool |