Allows for interacting with session storage in isolated containers, which
may have their own expiries, or even expiries per key in the container.
Additionally, expiries may be absolute TTLs or measured in "hops", which
are based on how many times the key or container were accessed.
Methods
Constructor
__construct(null | string $name, \Zend\Session\ManagerInterface $manager) : \Zend\Stdlib\ArrayObject
Provide a name ('Default' if none provided) and a ManagerInterface instance.
Parameters
$name
nullstring
Exceptions
Returns
append()
append()
Inherited
| inherited_from |
ArrayObject::append() |
| inherited_from |
\Zend\Stdlib\ArrayObject::append() |
asort()
asort()
Inherited
| inherited_from |
ArrayObject::asort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::asort() |
count()
count()
Inherited
| inherited_from |
ArrayObject::count() |
| inherited_from |
\Zend\Stdlib\ArrayObject::count() |
Exchange the current array with another array or object.
exchangeArray(array | object $input) : array
| see |
\Zend\Stdlib\ArrayObject::exchangeArray() |
Parameters
$input
arrayobject
Returns
arrayReturns the old array
getArrayCopy()
getArrayCopy()
Inherited
| inherited_from |
ArrayObject::getArrayCopy() |
| inherited_from |
\Zend\Stdlib\ArrayObject::getArrayCopy() |
getFlags()
getFlags()
Inherited
| inherited_from |
ArrayObject::getFlags() |
| inherited_from |
\Zend\Stdlib\ArrayObject::getFlags() |
Iterate over session container
getIterator() : \Iterator
getIteratorClass()
getIteratorClass()
Inherited
| inherited_from |
ArrayObject::getIteratorClass() |
| inherited_from |
\Zend\Stdlib\ArrayObject::getIteratorClass() |
Get container name
getName() : string
ksort()
ksort()
Inherited
| inherited_from |
ArrayObject::ksort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::ksort() |
natcasesort()
natcasesort()
Inherited
| inherited_from |
ArrayObject::natcasesort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::natcasesort() |
natsort()
natsort()
Inherited
| inherited_from |
ArrayObject::natsort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::natsort() |
Determine if the key exists
offsetExists(string $key) : bool
Parameters
$key
string
Returns
bool
Retrieve a specific key in the container
offsetGet(string $key) : mixed
Parameters
$key
string
Returns
mixed
Store a value within the container
offsetSet(string $key, mixed $value) : void
Parameters
$key
string
$value
mixed
Unset a single key in the container
offsetUnset(string $key) : void
serialize()
serialize()
Inherited
| inherited_from |
ArrayObject::serialize() |
| inherited_from |
\Zend\Stdlib\ArrayObject::serialize() |
Set the default ManagerInterface instance to use when none provided to constructor
setDefaultManager(\Zend\Session\ManagerInterface $manager) : void
Set expiration hops for the container, a single key, or set of keys
setExpirationHops(int $hops, null | string | array $vars) : \Zend\Session\Container
Parameters
$hops
int
$vars
nullstringarray
Exceptions
Returns
Set expiration TTL
setExpirationSeconds(int $ttl, string | array | null $vars) : \Zend\Session\Container
Set the TTL for the entire container, a single key, or a set of keys.
Parameters
$vars
stringarraynull
Exceptions
Returns
setFlags()
setFlags()
Inherited
| inherited_from |
ArrayObject::setFlags() |
| inherited_from |
\Zend\Stdlib\ArrayObject::setFlags() |
setIteratorClass()
setIteratorClass()
Inherited
| inherited_from |
ArrayObject::setIteratorClass() |
| inherited_from |
\Zend\Stdlib\ArrayObject::setIteratorClass() |
uasort()
uasort()
Inherited
| inherited_from |
ArrayObject::uasort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::uasort() |
uksort()
uksort()
Inherited
| inherited_from |
ArrayObject::uksort() |
| inherited_from |
\Zend\Stdlib\ArrayObject::uksort() |
unserialize()
unserialize()
Inherited
| inherited_from |
ArrayObject::unserialize() |
| inherited_from |
\Zend\Stdlib\ArrayObject::unserialize() |
Expire a key by expiry time
expireByExpiryTime(\Zend\Session\Storage\StorageInterface $storage, string $name, string $key) : bool
Checks to see if the entire container has expired based on TTL setting,
or the individual key.
Parameters
$name
stringContainer name
$key
stringKey in container to check
Returns
bool
Expire key by session hops
expireByHops(\Zend\Session\Storage\StorageInterface $storage, string $name, string $key) : bool
Determines whether the container or an individual key within it has
expired based on session hops
Parameters
$name
string
$key
string
Returns
bool
Determine whether a given key needs to be expired
expireKeys(null | string $key) : bool
Returns true if the key has expired, false otherwise.
Parameters
$key
nullstring
Returns
bool
Set session manager
setManager(\Zend\Session\ManagerInterface $manager) : \Zend\Session\Container
Parameters
Exceptions
Returns
Verify container namespace
verifyNamespace(bool $createContainer) : \Zend\Session\Storage\StorageInterface | null
Checks to see if a container exists within the Storage object already.
If not, one is created; if so, checks to see if it's an ArrayObject.
If not, it raises an exception; otherwise, it returns the Storage
object.
Parameters
$createContainer
boolWhether or not to create the container for the namespace
Exceptions
Returns
Properties
Default manager class to use if no manager has been provided
$managerDefaultClass : string
Container name
$name : string