Collection of signal handler return values

category Zend
package Zend_EventManager
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \SplStack

 Methods

Return last element in the stack

bottom() : mixed
Inherited

Returns

mixed

Check if any of the responses match the given value.

contains(mixed $value) 

Parameters

$value

mixed

The value to look for among responses

Countable: return count of items in the stack

count() : integer
Inherited

Returns

integer

Iterator: return current item in the stack

current() : mixed
Inherited

Returns

mixed

Convenient access to the first handler return value.

first() : mixed

Returns

mixedThe first handler return value

Get iteration mode

getIteratorMode() : integer
Inherited

Returns

integer

Is the stack empty?

isEmpty() : boolean
Inherited

Returns

boolean

Iterator: return key of current item in the stack

key() : mixed
Inherited

Returns

mixed

Convenient access to the last handler return value.

last() : mixed

If the collection is empty, returns null. Otherwise, returns value returned by last handler.

Returns

mixedThe last handler return value

Iterator: advance pointer to next item in the stack

next() : void
Inherited

ArrayAccess: does an item exist at the specified offset?

offsetExists(mixed $index) : boolean
Inherited

Parameters

$index

mixed

Returns

boolean

ArrayAccess: get the item at the specified offset

offsetGet(mixed $index) : mixed
Inherited

Parameters

$index

mixed

Exceptions

\OutOfRangeException

Returns

mixed

ArrayAccess: add an item at the specified offset

offsetSet(mixed $index, mixed $newval) : void
Inherited

Parameters

$index

mixed

$newval

mixed

ArrayAccess: unset the item at the specified offset

offsetUnset(mixed $index) : void
Inherited

Parameters

$index

mixed

Exceptions

\OutOfRangeException

Pop a node from the end of the stack

pop() : mixed
Inherited

Exceptions

\RuntimeException

Returns

mixed

Move the iterator to the previous node

prev() : void
Inherited
todo Does this need to be implemented?

Push an element to the list

push(mixed $value) : void
Inherited

Parameters

$value

mixed

Iterator: rewind to beginning of stack

rewind() : void
Inherited

Serialize the storage

serialize() : string
Inherited

Returns

string

Set the iterator mode

setIteratorMode(integer $mode) : void
Inherited

Must be set to one of IT_MODE_DELETE or IT_MODE_KEEP

todo Currently, IteratorMode is ignored, as we use the default (keep); should this be implemented?

Parameters

$mode

integer

Exceptions

\InvalidArgumentException

Mark the collection as stopped (or its opposite)

setStopped(boolean $flag) : \Zend_EventManager_ResponseCollection

Parameters

$flag

boolean

Returns

\Zend_EventManager_ResponseCollection

Shifts a node from the beginning of the list

shift() : mixed
Inherited

Exceptions

\RuntimeException

Returns

mixed

Did the last response provided trigger a short circuit of the stack?

stopped() : boolean

Returns

boolean

Peek at the top node of the stack

top() : mixed
Inherited

Returns

mixed

Unserialize the storage

unserialize($serialized) : void
Inherited

Parameters

$serialized

Unshift a node onto the beginning of the list

unshift(mixed $value) : void
Inherited

Parameters

$value

mixed

Iterator: is the current pointer valid?

valid() : boolean
Inherited

Returns

boolean

 Properties

 

Count of elements in the stack

$count : integer

Default

0
 

Data represented by this stack

$data : array

Default

array()
 

Mode used when iterating

$mode : integer

Default

self::IT_MODE_KEEP
 

Sorted stack of values

$stack : false | array

Default

false
 

$stopped

$stopped 

Default

false

 Constants

 

Delete items during iteration

IT_MODE_DELETE = 1 
 

Keep items during iteration

IT_MODE_KEEP = 0