All Components → laminas/laminas-session → Class AbstractSessionArrayStorage

Class AbstractSessionArrayStorage

Summary

Fully Qualified Name:	Laminas\Session\Storage\AbstractSessionArrayStorage
Implements:	IteratorAggregate, StorageInterface, StorageInitializationInterface

Description

Session storage in $_SESSION

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

Methods

Name	Description	Defined By
__construct()	Constructor	AbstractSessionArrayStorage
__destruct()	Destructor	AbstractSessionArrayStorage
__get()	Get Offset	AbstractSessionArrayStorage
__isset()	Isset Offset	AbstractSessionArrayStorage
__set()	Set Offset	AbstractSessionArrayStorage
__unset()	Unset Offset	AbstractSessionArrayStorage
clear()	Clear the storage object or a subkey of the object	AbstractSessionArrayStorage
count()	Count	AbstractSessionArrayStorage
fromArray()	Load session object from an existing array	AbstractSessionArrayStorage
getIterator()	Get Iterator	AbstractSessionArrayStorage
getMetadata()	Retrieve metadata for the storage object or a specific metadata key	AbstractSessionArrayStorage
getRequestAccessTime()	Retrieve the request access time	AbstractSessionArrayStorage
init()	Initialize Storage	AbstractSessionArrayStorage
isImmutable()	Determine if this object is isImmutable	AbstractSessionArrayStorage
isLocked()	Is the object or key marked as locked?	AbstractSessionArrayStorage
lock()	Lock this storage instance, or a key within it	AbstractSessionArrayStorage
markImmutable()	Mark object as isImmutable	AbstractSessionArrayStorage
offsetExists()	Offset Exists	AbstractSessionArrayStorage
offsetGet()	Offset Get	AbstractSessionArrayStorage
offsetSet()	Offset Set	AbstractSessionArrayStorage
offsetUnset()	Offset Unset	AbstractSessionArrayStorage
serialize()	Seralize	AbstractSessionArrayStorage
setMetadata()	Set storage metadata	AbstractSessionArrayStorage
toArray()	Cast the object to an array	AbstractSessionArrayStorage
unlock()	Unlock an object or key marked as locked	AbstractSessionArrayStorage
unserialize()	Unserialize	AbstractSessionArrayStorage

Method Details

__construct()

Constructor

Parameter Name	Type	Description
$input	array\|null

Returns:

__destruct()

Destructor

Returns: void

__get()

Get Offset

Parameter Name	Type	Description
$key	mixed

Returns: mixed

__isset()

Isset Offset

Parameter Name	Type	Description
$key	mixed

Returns: bool

__set()

Set Offset

Parameter Name	Type	Description
$key	mixed
$value	mixed

Returns: void

__unset()

Unset Offset

Parameter Name	Type	Description
$key	mixed

Returns: void

clear()

Clear the storage object or a subkey of the object

Parameter Name	Type	Description
$key	null\|int\|string

Returns: \ArrayStorage

count()

Count

Returns: int

fromArray()

Load session object from an existing array

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

Parameter Name	Type	Description
$array	array

Returns: \SessionStorage

getIterator()

Get Iterator

Returns: \ArrayIterator

getMetadata()

Retrieve metadata for the storage object or a specific metadata key

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

Parameter Name	Type	Description
$key	null\|int\|string

Returns: mixed

getRequestAccessTime()

Retrieve the request access time

Returns: float

init()

Initialize Storage

Parameter Name	Type	Description
$input	array

Returns: void

isImmutable()

Determine if this object is isImmutable

Returns: bool

isLocked()

Is the object or key marked as locked?

Parameter Name	Type	Description
$key	null\|int\|string

Returns: bool

lock()

Lock this storage instance, or a key within it

Parameter Name	Type	Description
$key	null\|int\|string

Returns: \ArrayStorage

markImmutable()

Mark object as isImmutable

Returns: \SessionStorage

offsetExists()

Offset Exists

Parameter Name	Type	Description
$key	mixed

Returns: bool

offsetGet()

Offset Get

Parameter Name	Type	Description
$key	mixed

Returns: mixed

offsetSet()

Offset Set

Parameter Name	Type	Description
$key	mixed
$value	mixed

Returns: void

offsetUnset()

Offset Unset

Parameter Name	Type	Description
$key	mixed

Returns: void

serialize()

Seralize

Returns: string

setMetadata()

Set storage metadata

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.

Parameter Name	Type	Description
$key	string
$value	mixed
$overwriteArray	bool	Whether

Returns: \ArrayStorage

toArray()

Cast the object to an array

Parameter Name	Type	Description
$metaData	bool	Whether

Returns: array

unlock()

Unlock an object or key marked as locked

Parameter Name	Type	Description
$key	null\|int\|string

Returns: \ArrayStorage

unserialize()

Unserialize

Parameter Name	Type	Description
$session	string

Returns: mixed