Array session storage

Defines an ArrayObject interface for accessing session storage, with options for setting metadata, locking, and marking as isImmutable.

category Zend
package Zend_Session
subpackage Storage

 Methods

Constructor

__construct(array $input, int $flags, string $iteratorClass) 

Instantiates storage as an ArrayObject, allowing property access. Also sets the initial request access time.

Parameters

$input

array

$flags

int

$iteratorClass

string

append()

append() 

inherited_from ArrayObject::append()

asort()

asort() 

inherited_from ArrayObject::asort()

Clear the storage object or a subkey of the object

clear(null | int | string $key) : \Zend\Session\Storage\ArrayStorage

Parameters

$key

nullintstring

Exceptions

\Zend\Session\Exception\RuntimeException

Returns

count()

count() 

inherited_from ArrayObject::count()

exchangeArray()

exchangeArray() 

inherited_from ArrayObject::exchangeArray()

Load the storage from another array

fromArray(array $array) : \Zend\Session\Storage\ArrayStorage

Overwrites any data that was previously set.

Parameters

$array

array

Returns

getArrayCopy()

getArrayCopy() 

inherited_from ArrayObject::getArrayCopy()

getFlags()

getFlags() 

inherited_from ArrayObject::getFlags()

getIterator()

getIterator() 

inherited_from ArrayObject::getIterator()

getIteratorClass()

getIteratorClass() 

inherited_from ArrayObject::getIteratorClass()

Retrieve the request access time

getRequestAccessTime() : float

Returns

float

Is the storage container marked as isImmutable?

isImmutable() : bool

Returns

bool

Is the object or key marked as locked?

isLocked(null | int | string $key) : bool

Parameters

$key

nullintstring

Returns

bool

ksort()

ksort() 

inherited_from ArrayObject::ksort()

Lock this storage instance, or a key within it

lock(null | int | string $key) : \Zend\Session\Storage\ArrayStorage

Parameters

$key

nullintstring

Returns

Mark the storage container as isImmutable

markImmutable() : \Zend\Session\Storage\ArrayStorage

natcasesort()

natcasesort() 

inherited_from ArrayObject::natcasesort()

natsort()

natsort() 

inherited_from ArrayObject::natsort()

offsetExists()

offsetExists() 

inherited_from ArrayObject::offsetExists()

offsetGet()

offsetGet() 

inherited_from ArrayObject::offsetGet()

offsetSet()

offsetSet(mixed $key, mixed $value) 

Parameters

$key

mixed

$value

mixed

Exceptions

\Zend\Session\Exception\RuntimeException

offsetUnset()

offsetUnset() 

inherited_from ArrayObject::offsetUnset()

serialize()

serialize() 

inherited_from ArrayObject::serialize()

setFlags()

setFlags() 

inherited_from ArrayObject::setFlags()

setIteratorClass()

setIteratorClass() 

inherited_from ArrayObject::setIteratorClass()

Cast the object to an array

toArray() : array

Returns data only, no metadata.

Returns

array

uasort()

uasort() 

inherited_from ArrayObject::uasort()

uksort()

uksort() 

inherited_from ArrayObject::uksort()

Unlock an object or key marked as locked

unlock(null | int | string $key) : \Zend\Session\Storage\ArrayStorage

Parameters

$key

nullintstring

Returns

unserialize()

unserialize() 

inherited_from ArrayObject::unserialize()

Set the request access time

setRequestAccessTime(float $time) : \Zend\Session\Storage\ArrayStorage

Parameters

$time

float

Returns

 Properties

 

Is storage marked isImmutable?

$isImmutable : bool