Zend Framework » \Zend\Session\Storage\SessionStorage

Session storage in $_SESSION

Replaces the $_SESSION superglobal with an ArrayObject that allows for property access, metadata storage, locking, and immutability.

Methods

Constructor

__construct(array | null $input, int $flags, string $iteratorClass) : \Zend\Stdlib\ArrayObject

Sets the $_SESSION superglobal to an ArrayObject, maintaining previous values if any discovered.

Parameters

$input

arraynull

$flags

int

$iteratorClass

string

Returns

\Zend\Stdlib\ArrayObject

Destructor

__destruct() : void

Resets $_SESSION superglobal to an array, by casting object using getArrayCopy().

append()

append()

Inherited

inherited_from	ArrayObject::append()
inherited_from	\Zend\Stdlib\ArrayObject::append()
inherited_from	\Zend\Session\Storage\ArrayStorage::append()

asort()

asort()

Inherited

inherited_from	ArrayObject::asort()
inherited_from	\Zend\Stdlib\ArrayObject::asort()
inherited_from	\Zend\Session\Storage\ArrayStorage::asort()

Clear the storage object or a subkey of the object

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

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::clear()

Parameters

$key

nullintstring

Exceptions

`\Zend\Session\Exception\RuntimeException`

Returns

\Zend\Session\Storage\ArrayStorage

count()

count()

Inherited

inherited_from	ArrayObject::count()
inherited_from	\Zend\Stdlib\ArrayObject::count()
inherited_from	\Zend\Session\Storage\ArrayStorage::count()

exchangeArray()

exchangeArray()

Inherited

inherited_from	ArrayObject::exchangeArray()
inherited_from	\Zend\Stdlib\ArrayObject::exchangeArray()
inherited_from	\Zend\Session\Storage\ArrayStorage::exchangeArray()

Load session object from an existing array

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

Ensures $_SESSION is set to an instance of the object when complete.

Parameters

$array

array

Returns

\Zend\Session\Storage\SessionStorage

getArrayCopy()

getArrayCopy()

Inherited

inherited_from	ArrayObject::getArrayCopy()
inherited_from	\Zend\Stdlib\ArrayObject::getArrayCopy()
inherited_from	\Zend\Session\Storage\ArrayStorage::getArrayCopy()

getFlags()

getFlags()

Inherited

inherited_from	ArrayObject::getFlags()
inherited_from	\Zend\Stdlib\ArrayObject::getFlags()
inherited_from	\Zend\Session\Storage\ArrayStorage::getFlags()

getIterator()

getIterator()

Inherited

inherited_from	ArrayObject::getIterator()
inherited_from	\Zend\Stdlib\ArrayObject::getIterator()
inherited_from	\Zend\Session\Storage\ArrayStorage::getIterator()

getIteratorClass()

getIteratorClass()

Inherited

inherited_from	ArrayObject::getIteratorClass()
inherited_from	\Zend\Stdlib\ArrayObject::getIteratorClass()
inherited_from	\Zend\Session\Storage\ArrayStorage::getIteratorClass()

Retrieve metadata for the storage object or a specific metadata key

getMetadata(null | int | string $key) : mixed

Inherited

Returns false if no metadata stored, or no metadata exists for the given key.

inherited_from	\Zend\Session\Storage\ArrayStorage::getMetadata()

Parameters

$key

nullintstring

Returns

mixed

Retrieve the request access time

getRequestAccessTime() : float

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::getRequestAccessTime()

Returns

float

Determine if this object is isImmutable

isImmutable() : bool

Returns

bool

Is the object or key marked as locked?

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

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::isLocked()

Parameters

$key

nullintstring

Returns

bool

ksort()

ksort()

Inherited

inherited_from	ArrayObject::ksort()
inherited_from	\Zend\Stdlib\ArrayObject::ksort()
inherited_from	\Zend\Session\Storage\ArrayStorage::ksort()

Lock this storage instance, or a key within it

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

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::lock()

Parameters

$key

nullintstring

Returns

\Zend\Session\Storage\ArrayStorage

Mark object as isImmutable

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

Returns

\Zend\Session\Storage\SessionStorage

natcasesort()

natcasesort()

Inherited

inherited_from	ArrayObject::natcasesort()
inherited_from	\Zend\Stdlib\ArrayObject::natcasesort()
inherited_from	\Zend\Session\Storage\ArrayStorage::natcasesort()

natsort()

natsort()

Inherited

inherited_from	ArrayObject::natsort()
inherited_from	\Zend\Stdlib\ArrayObject::natsort()
inherited_from	\Zend\Session\Storage\ArrayStorage::natsort()

offsetExists()

offsetExists()

Inherited

inherited_from	ArrayObject::offsetExists()
inherited_from	\Zend\Stdlib\ArrayObject::offsetExists()
inherited_from	\Zend\Session\Storage\ArrayStorage::offsetExists()

offsetGet()

offsetGet()

Inherited

inherited_from	ArrayObject::offsetGet()
inherited_from	\Zend\Stdlib\ArrayObject::offsetGet()
inherited_from	\Zend\Session\Storage\ArrayStorage::offsetGet()

offsetSet()

offsetSet(mixed $key, mixed $value)

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::offsetSet()

Parameters

$key

mixed

$value

mixed

Exceptions

`\Zend\Session\Exception\RuntimeException`

offsetUnset()

offsetUnset()

Inherited

inherited_from	ArrayObject::offsetUnset()
inherited_from	\Zend\Stdlib\ArrayObject::offsetUnset()
inherited_from	\Zend\Session\Storage\ArrayStorage::offsetUnset()

serialize()

serialize()

Inherited

inherited_from	ArrayObject::serialize()
inherited_from	\Zend\Stdlib\ArrayObject::serialize()
inherited_from	\Zend\Session\Storage\ArrayStorage::serialize()

setFlags()

setFlags()

Inherited

inherited_from	ArrayObject::setFlags()
inherited_from	\Zend\Stdlib\ArrayObject::setFlags()
inherited_from	\Zend\Session\Storage\ArrayStorage::setFlags()

setIteratorClass()

setIteratorClass()

Inherited

inherited_from	ArrayObject::setIteratorClass()
inherited_from	\Zend\Stdlib\ArrayObject::setIteratorClass()
inherited_from	\Zend\Session\Storage\ArrayStorage::setIteratorClass()

Set storage metadata

setMetadata(string $key, mixed $value, bool $overwriteArray) : \Zend\Session\Storage\ArrayStorage

Inherited

Metadata is used to store information about the data being stored in the object. Some example use cases include: - Setting expiry data - Maintaining access counts - localizing session storage - etc.

inherited_from	\Zend\Session\Storage\ArrayStorage::setMetadata()

Parameters

$key

string

$value

mixed

$overwriteArray

bool

Whether to overwrite or merge array values; by default, merges

Exceptions

`\Zend\Session\Exception\RuntimeException`

Returns

\Zend\Session\Storage\ArrayStorage

Cast the object to an array

toArray($metaData) : array

Inherited

Returns data only, no metadata.

inherited_from	\Zend\Session\Storage\ArrayStorage::toArray()

Parameters

$metaData

Returns

array

uasort()

uasort()

Inherited

inherited_from	ArrayObject::uasort()
inherited_from	\Zend\Stdlib\ArrayObject::uasort()
inherited_from	\Zend\Session\Storage\ArrayStorage::uasort()

uksort()

uksort()

Inherited

inherited_from	ArrayObject::uksort()
inherited_from	\Zend\Stdlib\ArrayObject::uksort()
inherited_from	\Zend\Session\Storage\ArrayStorage::uksort()

Unlock an object or key marked as locked

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

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::unlock()

Parameters

$key

nullintstring

Returns

\Zend\Session\Storage\ArrayStorage

unserialize()

unserialize()

Inherited

inherited_from	ArrayObject::unserialize()
inherited_from	\Zend\Stdlib\ArrayObject::unserialize()
inherited_from	\Zend\Session\Storage\ArrayStorage::unserialize()

Set the request access time

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

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::setRequestAccessTime()

Parameters

$time

float

Returns

\Zend\Session\Storage\ArrayStorage

Properties

Is storage marked isImmutable?

$isImmutable : bool

Inherited

inherited_from	\Zend\Session\Storage\ArrayStorage::$$isImmutable