Zend Framework
Back to top  

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) 
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::__construct()

Parameters

$input

arraynull

Destructor

__destruct() : void
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::__destruct()

Get Offset

__get(mixed $key) : mixed

Parameters

$key

mixed

Returns

mixed

Isset Offset

__isset(mixed $key) : bool
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::__isset()

Parameters

$key

mixed

Returns

bool

Set Offset

__set(mixed $key, mixed $value) : void
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::__set()

Parameters

$key

mixed

$value

mixed

Unset Offset

__unset(mixed $key) : void
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::__unset()

Parameters

$key

mixed

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\AbstractSessionArrayStorage::clear()

Parameters

$key

nullintstring

Exceptions

\Zend\Session\Exception\RuntimeException

Returns

\Zend\Session\Storage\ArrayStorage

Count

count() : int
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::count()

Returns

int

Load session object from an existing array

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

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

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::fromArray()

Parameters

$array

array

Returns

\Zend\Session\Storage\SessionStorage

Get Iterator

getIterator() : \ArrayIterator
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::getIterator()

Returns

\ArrayIterator

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\AbstractSessionArrayStorage::getMetadata()

Parameters

$key

nullintstring

Returns

mixed

Retrieve the request access time

getRequestAccessTime() : float
Inherited

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

Returns

float

Initialize Storage

init(array $input) : void
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::init()

Parameters

$input

array

Determine if this object is isImmutable

isImmutable() : bool
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::isImmutable()

Returns

bool

Is the object or key marked as locked?

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

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

Parameters

$key

nullintstring

Returns

bool

Lock this storage instance, or a key within it

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

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

Parameters

$key

nullintstring

Returns

\Zend\Session\Storage\ArrayStorage

Mark object as isImmutable

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

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::markImmutable()

Returns

\Zend\Session\Storage\SessionStorage

Offset Exists

offsetExists(mixed $key) : bool
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::offsetExists()

Parameters

$key

mixed

Returns

bool

Offset Get

offsetGet(mixed $key) : mixed

Parameters

$key

mixed

Returns

mixed

Offset Set

offsetSet(mixed $key, mixed $value) : void
Inherited

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

Parameters

$key

mixed

$value

mixed

Offset Unset

offsetUnset(mixed $key) : void
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::offsetUnset()

Parameters

$key

mixed

Seralize

serialize() : string
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::serialize()

Returns

string

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\AbstractSessionArrayStorage::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(bool $metaData) : array
Inherited

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

Parameters

$metaData

bool

Whether to include metadata

Returns

array

Unlock an object or key marked as locked

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

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

Parameters

$key

nullintstring

Returns

\Zend\Session\Storage\ArrayStorage

Unserialize

unserialize(string $session) : mixed
Inherited

inherited_from \Zend\Session\Storage\AbstractSessionArrayStorage::unserialize()

Parameters

$session

string

Returns

mixed

Set the request access time

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

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

Parameters

$time

float

Returns

\Zend\Session\Storage\ArrayStorage