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)
Provide a name ('Default' if none provided) and a ManagerInterface instance.
Parameters
$name
nullstring
Exceptions
Returns the value at the specified key by reference
__get(mixed $key) : mixed
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::__get() |
Parameters
$key
mixed
Returns
mixed
Returns whether the requested key exists
__isset(mixed $key) : bool
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::__isset() |
Parameters
$key
mixed
Returns
bool
Sets the value at the specified key to value
__set(mixed $key, mixed $value) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::__set() |
Parameters
$key
mixed
$value
mixed
Unsets the value at the specified key
__unset(mixed $key) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::__unset() |
Parameters
$key
mixed
Appends the value
append(mixed $value) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::append() |
Parameters
$value
mixed
Sort the entries by value
asort() : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::asort() |
Get the number of public properties in the ArrayObject
count() : int
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::count() |
Returns
int
Exchange the current array with another array or object.
exchangeArray(array | object $input) : array
see |
\Zend\Stdlib\ArrayObject::exchangeArray() |
Parameters
$input
arrayobject
Returns
array
Returns the old array
Creates a copy of the specific container name
getArrayCopy() : array
Gets the behavior flags.
getFlags() : int
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::getFlags() |
Returns
int
Iterate over session container
getIterator() : \Iterator
Gets the iterator classname for the ArrayObject.
getIteratorClass() : string
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::getIteratorClass() |
Returns
string
Get container name
getName() : string
Sort the entries by key
ksort() : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::ksort() |
Sort an array using a case insensitive "natural order" algorithm
natcasesort() : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::natcasesort() |
Sort entries using a "natural order" algorithm
natsort() : void
Inherited
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 an ArrayObject
serialize() : string
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::serialize() |
Returns
string
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
Sets the behavior flags
setFlags(int $flags) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::setFlags() |
Parameters
$flags
int
Sets the iterator classname for the ArrayObject
setIteratorClass(string $class) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::setIteratorClass() |
Parameters
$class
string
Sort the entries with a user-defined comparison function and maintain key association
uasort(\Zend\Stdlib\callable $function) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::uasort() |
Parameters
$function
\Zend\Stdlib\callable
Sort the entries by keys using a user-defined comparison function
uksort(\Zend\Stdlib\callable $function) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::uksort() |
Parameters
$function
\Zend\Stdlib\callable
Unserialize an ArrayObject
unserialize(string $data) : void
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::unserialize() |
Parameters
$data
string
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
string
Container name
$key
string
Key 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
bool
Whether or not to create the container for the namespace
Exceptions
Returns
Properties
$flag
$flag : int
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::$$flag |
$iteratorClass
$iteratorClass : string
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::$$iteratorClass |
Default manager class to use if no manager has been provided
$managerDefaultClass : string
Container name
$name : string
$protectedProperties
$protectedProperties : array
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::$$protectedProperties |
$storage
$storage : array
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::$$storage |
Constants
Entries can be accessed as properties (read and write).
ARRAY_AS_PROPS
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::ARRAY_AS_PROPS |
Properties of the object have their normal functionality
when accessed as list (var_dump, foreach, etc.).
STD_PROP_LIST
Inherited
inherited_from |
\Zend\Stdlib\ArrayObject::STD_PROP_LIST |