Session storage container for PHP 5.3.4 and above.
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)
Inherited
Provide a name ('Default' if none provided) and a ManagerInterface instance.
| inherited_from |
\Zend\Session\AbstractContainer::__construct() |
Parameters
$name
nullstring
Exceptions
Exchange the current array with another array or object.
exchangeArray(array | object $input) : array
Inherited
| see |
\Zend\Stdlib\ArrayObject::exchangeArray() |
| inherited_from |
\Zend\Session\AbstractContainer::exchangeArray() |
Parameters
$input
arrayobject
Returns
arrayReturns the old array
Creates a copy of the specific container name
getArrayCopy() : array
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::getArrayCopy() |
Returns
array
Get the default ManagerInterface instance
getDefaultManager() : \Zend\Session\ManagerInterface
Inherited
If none provided, instantiates one of type $managerDefaultClass
| inherited_from |
\Zend\Session\AbstractContainer::getDefaultManager() |
Exceptions
Returns
Iterate over session container
getIterator() : \Iterator
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::getIterator() |
Returns
\Iterator
Get container name
getName() : string
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::getName() |
Returns
string
Determine if the key exists
offsetExists(string $key) : bool
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::offsetExists() |
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
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::offsetSet() |
Parameters
$key
string
$value
mixed
Unset a single key in the container
offsetUnset(string $key) : void
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::offsetUnset() |
Parameters
$key
string
Set the default ManagerInterface instance to use when none provided to constructor
setDefaultManager(\Zend\Session\ManagerInterface $manager) : void
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::setDefaultManager() |
Parameters
Set expiration hops for the container, a single key, or set of keys
setExpirationHops(int $hops, null | string | array $vars) : \Zend\Session\Container
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::setExpirationHops() |
Parameters
$hops
int
$vars
nullstringarray
Exceptions
Returns
Set expiration TTL
setExpirationSeconds(int $ttl, string | array | null $vars) : \Zend\Session\Container
Inherited
Set the TTL for the entire container, a single key, or a set of keys.
| inherited_from |
\Zend\Session\AbstractContainer::setExpirationSeconds() |
Parameters
$vars
stringarraynull
Exceptions
Returns
Create a new container object on which to act
createContainer() : \Zend\Stdlib\ArrayObject
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::createContainer() |
Returns
Expire a key by expiry time
expireByExpiryTime(\Zend\Session\Storage\StorageInterface $storage, string $name, string $key) : bool
Inherited
Checks to see if the entire container has expired based on TTL setting,
or the individual key.
| inherited_from |
\Zend\Session\AbstractContainer::expireByExpiryTime() |
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
Inherited
Determines whether the container or an individual key within it has
expired based on session hops
| inherited_from |
\Zend\Session\AbstractContainer::expireByHops() |
Parameters
$name
string
$key
string
Returns
bool
Determine whether a given key needs to be expired
expireKeys(null | string $key) : bool
Inherited
Returns true if the key has expired, false otherwise.
| inherited_from |
\Zend\Session\AbstractContainer::expireKeys() |
Parameters
$key
nullstring
Returns
bool
Get session storage object
getStorage() : \Zend\Session\Storage\StorageInterface
Inherited
Proxies to ManagerInterface::getStorage()
| inherited_from |
\Zend\Session\AbstractContainer::getStorage() |
Returns
Set session manager
setManager(\Zend\Session\ManagerInterface $manager) : \Zend\Session\Container
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::setManager() |
Parameters
Exceptions
Returns
Verify container namespace
verifyNamespace(bool $createContainer) : \Zend\Session\Storage\StorageInterface | null
Inherited
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.
| inherited_from |
\Zend\Session\AbstractContainer::verifyNamespace() |
Parameters
$createContainer
boolWhether or not to create the container for the namespace
Exceptions
Returns
Properties
Default manager to use when instantiating a container without providing a ManagerInterface
$defaultManager : \Zend\Session\ManagerInterface
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::$$defaultManager |
Default manager class to use if no manager has been provided
$managerDefaultClass : string
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::$$managerDefaultClass |
Container name
$name : string
Inherited
| inherited_from |
\Zend\Session\AbstractContainer::$$name |