Zend Framework » \Zend\Session\Container

Methods
Retrieve a specific key in the container
```
offsetGet()
```

Session storage container

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

Retrieve a specific key in the container

offsetGet(string $key) : mixed

Parameters

$key

string

Returns

mixed

Session storage container for PHP 5.3.3 and less

Methods

Constructor

__construct(null | string $name, \Zend\Session\ManagerInterface $manager) : \Zend\Stdlib\ArrayObject

Inherited

Provide a name ('Default' if none provided) and a ManagerInterface instance.

inherited_from	\Zend\Session\AbstractContainer::__construct()

Parameters

$name

nullstring

$manager

\Zend\Session\ManagerInterface

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Stdlib\ArrayObject

append()

append()

Inherited

inherited_from	ArrayObject::append()
inherited_from	\Zend\Stdlib\ArrayObject::append()
inherited_from	\Zend\Session\AbstractContainer::append()

asort()

asort()

Inherited

inherited_from	ArrayObject::asort()
inherited_from	\Zend\Stdlib\ArrayObject::asort()
inherited_from	\Zend\Session\AbstractContainer::asort()

count()

count()

Inherited

inherited_from	ArrayObject::count()
inherited_from	\Zend\Stdlib\ArrayObject::count()
inherited_from	\Zend\Session\AbstractContainer::count()

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

getArrayCopy()

getArrayCopy()

Inherited

inherited_from	ArrayObject::getArrayCopy()
inherited_from	\Zend\Stdlib\ArrayObject::getArrayCopy()
inherited_from	\Zend\Session\AbstractContainer::getArrayCopy()

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

`\Zend\Session\Exception\InvalidArgumentException`	if invalid manager default class provided

Returns

\Zend\Session\ManagerInterface

getFlags()

getFlags()

Inherited

inherited_from	ArrayObject::getFlags()
inherited_from	\Zend\Stdlib\ArrayObject::getFlags()
inherited_from	\Zend\Session\AbstractContainer::getFlags()

Iterate over session container

getIterator() : \Iterator

Inherited

inherited_from	\Zend\Session\AbstractContainer::getIterator()

Returns

\Iterator

getIteratorClass()

getIteratorClass()

Inherited

inherited_from	ArrayObject::getIteratorClass()
inherited_from	\Zend\Stdlib\ArrayObject::getIteratorClass()
inherited_from	\Zend\Session\AbstractContainer::getIteratorClass()

Get manager instance

getManager() : \Zend\Session\ManagerInterface

Inherited

inherited_from	\Zend\Session\AbstractContainer::getManager()

Returns

\Zend\Session\ManagerInterface

Get container name

getName() : string

Inherited

inherited_from	\Zend\Session\AbstractContainer::getName()

Returns

string

ksort()

ksort()

Inherited

inherited_from	ArrayObject::ksort()
inherited_from	\Zend\Stdlib\ArrayObject::ksort()
inherited_from	\Zend\Session\AbstractContainer::ksort()

natcasesort()

natcasesort()

Inherited

inherited_from	ArrayObject::natcasesort()
inherited_from	\Zend\Stdlib\ArrayObject::natcasesort()
inherited_from	\Zend\Session\AbstractContainer::natcasesort()

natsort()

natsort()

Inherited

inherited_from	ArrayObject::natsort()
inherited_from	\Zend\Stdlib\ArrayObject::natsort()
inherited_from	\Zend\Session\AbstractContainer::natsort()

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

Inherited

inherited_from	\Zend\Session\AbstractContainer::offsetGet()

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

serialize()

serialize()

Inherited

inherited_from	ArrayObject::serialize()
inherited_from	\Zend\Stdlib\ArrayObject::serialize()
inherited_from	\Zend\Session\AbstractContainer::serialize()

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

$manager

\Zend\Session\ManagerInterface

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

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\Container

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

$ttl

int

TTL in seconds

$vars

stringarraynull

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\Container

setFlags()

setFlags()

Inherited

inherited_from	ArrayObject::setFlags()
inherited_from	\Zend\Stdlib\ArrayObject::setFlags()
inherited_from	\Zend\Session\AbstractContainer::setFlags()

setIteratorClass()

setIteratorClass()

Inherited

inherited_from	ArrayObject::setIteratorClass()
inherited_from	\Zend\Stdlib\ArrayObject::setIteratorClass()
inherited_from	\Zend\Session\AbstractContainer::setIteratorClass()

uasort()

uasort()

Inherited

inherited_from	ArrayObject::uasort()
inherited_from	\Zend\Stdlib\ArrayObject::uasort()
inherited_from	\Zend\Session\AbstractContainer::uasort()

uksort()

uksort()

Inherited

inherited_from	ArrayObject::uksort()
inherited_from	\Zend\Stdlib\ArrayObject::uksort()
inherited_from	\Zend\Session\AbstractContainer::uksort()

unserialize()

unserialize()

Inherited

inherited_from	ArrayObject::unserialize()
inherited_from	\Zend\Stdlib\ArrayObject::unserialize()
inherited_from	\Zend\Session\AbstractContainer::unserialize()

Create a new container object on which to act

createContainer() : \Zend\Stdlib\ArrayObject

Inherited

inherited_from	\Zend\Session\AbstractContainer::createContainer()

Returns

\Zend\Stdlib\ArrayObject

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

$storage

\Zend\Session\Storage\StorageInterface

$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

Inherited

Determines whether the container or an individual key within it has expired based on session hops

inherited_from	\Zend\Session\AbstractContainer::expireByHops()

Parameters

$storage

\Zend\Session\Storage\StorageInterface

$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

\Zend\Session\Storage\StorageInterface

Set session manager

setManager(\Zend\Session\ManagerInterface $manager) : \Zend\Session\Container

Inherited

inherited_from	\Zend\Session\AbstractContainer::setManager()

Parameters

$manager

null\Zend\Session\ManagerInterface

Exceptions

`\Zend\Session\Exception\InvalidArgumentException`

Returns

\Zend\Session\Container

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

bool

Whether or not to create the container for the namespace

Exceptions

`\Zend\Session\Exception\RuntimeException`

Returns

\Zend\Session\Storage\StorageInterfacenullReturns null only if $createContainer is false

Properties

Default manager to use when instantiating a container without providing a ManagerInterface

$defaultManager : \Zend\Session\ManagerInterface

Inherited

inherited_from	\Zend\Session\AbstractContainer::$$defaultManager

$manager

$manager : \Zend\Session\ManagerInterface

Inherited

inherited_from	\Zend\Session\AbstractContainer::$$manager

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