EventManager/ResponseCollection.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 license@zend.com so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_EventManager  

\SplStack
jump to top

Package: Zend_EventManager
Implements
Children
\Zend_EventManager_ResponseCollection

Constants

>VConstant  IT_MODE_DELETE = 1
Delete items during iteration
>VConstant  IT_MODE_KEEP = 0
Keep items during iteration

Properties

>VPropertyprotectedint $count = 0
Count of elements in the stack
Default value0Details
Type
int
>VPropertyprotectedarray $data = array()
Data represented by this stack
Default valuearray()Details
Type
array
>VPropertyprotectedint $mode = self::IT_MODE_KEEP
Mode used when iterating
Default valueself::IT_MODE_KEEPDetails
Type
int
>VPropertyprotectedfalse|array $stack = false
Sorted stack of values
Default valuefalseDetails
Type
false | array

Methods

methodpublicbottom() : mixed

Return last element in the stack

Returns
TypeDescription
mixed
methodpubliccount() : int

Countable: return count of items in the stack

Returns
TypeDescription
int
methodpubliccurrent() : mixed

Iterator: return current item in the stack

Returns
TypeDescription
mixed
methodpublicgetIteratorMode() : int

Get iteration mode

Returns
TypeDescription
int
methodpublicisEmpty() : bool

Is the stack empty?

Returns
TypeDescription
bool
methodpublickey() : mixed

Iterator: return key of current item in the stack

Returns
TypeDescription
mixed
methodpublicnext() : void

Iterator: advance pointer to next item in the stack

methodpublicoffsetExists(mixed $index) : bool

ArrayAccess: does an item exist at the specified offset?

Parameters
NameTypeDescription
$indexmixed
Returns
TypeDescription
bool
methodpublicoffsetGet(mixed $index) : mixed

ArrayAccess: get the item at the specified offset

Parameters
NameTypeDescription
$indexmixed
Returns
TypeDescription
mixed
Throws
ExceptionDescription
\OutOfRangeException
methodpublicoffsetSet(mixed $index, mixed $newval) : void

ArrayAccess: add an item at the specified offset

Parameters
NameTypeDescription
$indexmixed
$newvalmixed
methodpublicoffsetUnset(mixed $index) : void

ArrayAccess: unset the item at the specified offset

Parameters
NameTypeDescription
$indexmixed
Throws
ExceptionDescription
\OutOfRangeException
methodpublicpop() : mixed

Pop a node from the end of the stack

Returns
TypeDescription
mixed
Throws
ExceptionDescription
\RuntimeException
methodpublicprev() : void

Move the iterator to the previous node

Details
Todo
Does this need to be implemented?  
methodpublicpush(mixed $value) : void

Push an element to the list

Parameters
NameTypeDescription
$valuemixed
methodpublicrewind() : void

Iterator: rewind to beginning of stack

methodpublicserialize() : string

Serialize the storage

Returns
TypeDescription
string
methodpublicsetIteratorMode(int $mode) : void

Set the iterator mode

Must be set to one of IT_MODE_DELETE or IT_MODE_KEEP
Parameters
NameTypeDescription
$modeint
Throws
ExceptionDescription
\InvalidArgumentException
Details
Todo
Currently, IteratorMode is ignored, as we use the default (keep); should this be implemented?  
methodpublicshift() : mixed

Shifts a node from the beginning of the list

Returns
TypeDescription
mixed
Throws
ExceptionDescription
\RuntimeException
methodpublictop() : mixed

Peek at the top node of the stack

Returns
TypeDescription
mixed
methodpublicunserialize( $serialized) : void

Unserialize the storage

Parameters
NameTypeDescription
$serialized
methodpublicunshift(mixed $value) : void

Unshift a node onto the beginning of the list

Parameters
NameTypeDescription
$valuemixed
methodpublicvalid() : bool

Iterator: is the current pointer valid?

Returns
TypeDescription
bool

\Zend_EventManager_ResponseCollection
jump to top

Package: Zend_EventManager
Collection of signal handler return values
Parent(s)
\SplStack
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected$stopped = false
Default valuefalseDetails
Type
n/a

Methods

methodpubliccontains(mixed $value) : void

Check if any of the responses match the given value.

Parameters
NameTypeDescription
$valuemixed

The value to look for among responses

methodpublicfirst() : mixed

Convenient access to the first handler return value.

Returns
TypeDescription
mixedThe first handler return value
methodpubliclast() : mixed

Convenient access to the last handler return value.

If the collection is empty, returns null. Otherwise, returns value returned by last handler.
Returns
TypeDescription
mixedThe last handler return value
methodpublicsetStopped(bool $flag) : \Zend_EventManager_ResponseCollection

Mark the collection as stopped (or its opposite)

Parameters
NameTypeDescription
$flagbool
Returns
TypeDescription
\Zend_EventManager_ResponseCollection
methodpublicstopped() : bool

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

Returns
TypeDescription
bool
Documentation was generated by phpDocumentor 2.2.0 .