EventManager/ResponseCollection.php

Show:

inherited

Classes
- \SplStack
- \Zend_EventManager_ResponseCollection

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 [email protected] 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

 
                IT_MODE_DELETE
                = 1

Delete items during iteration

 
                IT_MODE_KEEP
                = 0

Keep items during iteration

Properties

int $count = 0

Count of elements in the stack

Default value0Details

Type: int

array $data = array()

Data represented by this stack

Default valuearray()Details

Type: array

int $mode = self::IT_MODE_KEEP

Mode used when iterating

Default valueself::IT_MODE_KEEPDetails

Type: int

false|array $stack = false

Sorted stack of values

Default valuefalseDetails

Type: false | array

Methods

bottom() : mixed

Return last element in the stack

Returns

Type	Description
mixed

count() : int

Countable: return count of items in the stack

Returns

Type	Description
int

current() : mixed

Iterator: return current item in the stack

Returns

Type	Description
mixed

getIteratorMode() : int

Get iteration mode

Returns

Type	Description
int

isEmpty() : bool

Is the stack empty?

Returns

Type	Description
bool

key() : mixed

Iterator: return key of current item in the stack

Returns

Type	Description
mixed

next() : void

Iterator: advance pointer to next item in the stack

offsetExists(mixed $index) : bool

ArrayAccess: does an item exist at the specified offset?

Parameters

Name	Type	Description
$index	mixed

Returns

Type	Description
bool

offsetGet(mixed $index) : mixed

ArrayAccess: get the item at the specified offset

Parameters

Name	Type	Description
$index	mixed

Returns

Type	Description
mixed

Throws

Exception	Description
\OutOfRangeException

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

ArrayAccess: add an item at the specified offset

Parameters

Name	Type	Description
$index	mixed
$newval	mixed

offsetUnset(mixed $index) : void

ArrayAccess: unset the item at the specified offset

Parameters

Name	Type	Description
$index	mixed

Throws

Exception	Description
\OutOfRangeException

pop() : mixed

Pop a node from the end of the stack

Returns

Type	Description
mixed

Throws

Exception	Description
\RuntimeException

prev() : void

Move the iterator to the previous node

Details

Todo: Does this need to be implemented?

push(mixed $value) : void

Push an element to the list

Parameters

Name	Type	Description
$value	mixed

rewind() : void

Iterator: rewind to beginning of stack

serialize() : string

Serialize the storage

Returns

Type	Description
string

setIteratorMode(int $mode) : void

Set the iterator mode

Must be set to one of IT_MODE_DELETE or IT_MODE_KEEP

Parameters

Name	Type	Description
$mode	int

Throws

Exception	Description
\InvalidArgumentException

Details

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

Returns

Type	Description
mixed

Throws

Exception	Description
\RuntimeException

top() : mixed

Peek at the top node of the stack

Returns

Type	Description
mixed

unserialize( $serialized) : void

Unserialize the storage

Parameters

Name	Type	Description
$serialized

unshift(mixed $value) : void

Unshift a node onto the beginning of the list

Parameters

Name	Type	Description
$value	mixed

valid() : bool

Iterator: is the current pointer valid?

Returns

Type	Description
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

$stopped = false

Default valuefalseDetails

Type: n/a

Methods

contains(mixed $value) : void

Check if any of the responses match the given value.

Parameters

Name	Type	Description
$value	mixed	The value to look for among responses

first() : mixed

Convenient access to the first handler return value.

Returns

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.

Returns

Type	Description
mixed	The last handler return value

setStopped(bool $flag) : \Zend_EventManager_ResponseCollection

Mark the collection as stopped (or its opposite)

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_EventManager_ResponseCollection

stopped() : bool

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

Returns

Type	Description
bool

EventManager/ResponseCollection.php

\SplStackjump to top

Constants

Properties

Methods

\Zend_EventManager_ResponseCollectionjump to top

Properties

Methods

\SplStack
jump to top

\Zend_EventManager_ResponseCollection
jump to top