Session storage container. More...
Public Member Functions | |
| & | offsetGet ($key) |
| Retrieve a specific key in the container. | |
 Public Member Functions inherited from AbstractContainer | |
| __construct ($name= 'Default', Manager $manager=null) | |
| Constructor. | |
| getName () | |
| Get container name. | |
| getManager () | |
| Get manager instance. | |
| offsetSet ($key, $value) | |
| Store a value within the container. | |
| offsetExists ($key) | |
| Determine if the key exists. | |
| offsetGet ($key) | |
| Retrieve a specific key in the container. | |
| offsetUnset ($key) | |
| Unset a single key in the container. | |
| exchangeArray ($input) | |
| Exchange the current array with another array or object. | |
| getIterator () | |
| Iterate over session container. | |
| setExpirationSeconds ($ttl, $vars=null) | |
| Set expiration TTL. | |
| setExpirationHops ($hops, $vars=null) | |
| Set expiration hops for the container, a single key, or set of keys. | |
| getArrayCopy () | |
| Creates a copy of the specific container name. | |
| Public Member Functions inherited from ArrayObject | |
| __construct ($input=[], $flags=self::STD_PROP_LIST, $iteratorClass= 'ArrayIterator') | |
| Constructor. | |
| __isset ($key) | |
| Returns whether the requested key exists. | |
| __set ($key, $value) | |
| Sets the value at the specified key to value. | |
| __unset ($key) | |
| Unsets the value at the specified key. | |
| & | __get ($key) |
| Returns the value at the specified key by reference. | |
| append ($value) | |
| Appends the value. | |
| asort () | |
| Sort the entries by value. | |
| count () | |
| Get the number of public properties in the ArrayObject. | |
| exchangeArray ($data) | |
| Exchange the array for another one. | |
| getArrayCopy () | |
| Creates a copy of the ArrayObject. | |
| getFlags () | |
| Gets the behavior flags. | |
| getIterator () | |
| Create a new iterator from an ArrayObject instance. | |
| getIteratorClass () | |
| Gets the iterator classname for the ArrayObject. | |
| ksort () | |
| Sort the entries by key. | |
| natcasesort () | |
| Sort an array using a case insensitive "natural order" algorithm. | |
| natsort () | |
| Sort entries using a "natural order" algorithm. | |
| offsetExists ($key) | |
| Returns whether the requested key exists. | |
| & | offsetGet ($key) |
| Returns the value at the specified key. | |
| offsetSet ($key, $value) | |
| Sets the value at the specified key to value. | |
| offsetUnset ($key) | |
| Unsets the value at the specified key. | |
| serialize () | |
| Serialize an ArrayObject. | |
| setFlags ($flags) | |
| Sets the behavior flags. | |
| setIteratorClass ($class) | |
| Sets the iterator classname for the ArrayObject. | |
| uasort ($function) | |
| Sort the entries with a user-defined comparison function and maintain key association. | |
| uksort ($function) | |
| Sort the entries by keys using a user-defined comparison function. | |
| unserialize ($data) | |
| Unserialize an ArrayObject. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from AbstractContainer | |
| static | setDefaultManager (Manager $manager=null) |
| Set the default ManagerInterface instance to use when none provided to constructor. | |
| static | getDefaultManager () |
| Get the default ManagerInterface instance. | |
| Public Attributes inherited from ArrayObject | |
| const | STD_PROP_LIST = 1 |
| Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.). | |
| const | ARRAY_AS_PROPS = 2 |
| Entries can be accessed as properties (read and write). | |
| Protected Member Functions inherited from AbstractContainer | |
| setManager (Manager $manager=null) | |
| Set session manager. | |
| getStorage () | |
| Get session storage object. | |
| createContainer () | |
| Create a new container object on which to act. | |
| verifyNamespace ($createContainer=true) | |
| Verify container namespace. | |
| expireKeys ($key=null) | |
| Determine whether a given key needs to be expired. | |
| expireByExpiryTime (Storage $storage, $name, $key) | |
| Expire a key by expiry time. | |
| expireByHops (Storage $storage, $name, $key) | |
| Expire key by session hops. | |
| Protected Attributes inherited from AbstractContainer | |
| $name | |
| $manager | |
| Static Protected Attributes inherited from AbstractContainer | |
| static | $managerDefaultClass = 'Zend\\Session\\SessionManager' |
| static | $defaultManager |
Detailed Description
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.
Member Function Documentation
| & offsetGet | ( | $key | ) |
Retrieve a specific key in the container.
- Parameters
-
string $key
- Returns
- mixed
