MetadataBag
class MetadataBag implements SessionBagInterface
Metadata container.
Adds metadata to the session.
Constants
CREATED | |
UPDATED | |
LIFETIME |
Methods
__construct(string $storageKey = '_sf2_meta', int $updateThreshold) | ||
initialize(array $array) Initializes the Bag. | ||
int | getLifetime() Gets the lifetime that the session cookie was set with. | |
stampNew(int $lifetime = null) Stamps a new session's metadata. | ||
string | getStorageKey() Gets the storage key for this bag. | |
int | getCreated() Gets the created timestamp metadata. | |
int | getLastUsed() Gets the last used metadata. | |
mixed | clear() Clears out data from bag. | |
string | getName() Gets this bag's name. | |
setName(string $name) Sets name. |
Details
__construct(string $storageKey = '_sf2_meta', int $updateThreshold)
Parameters
string | $storageKey | The key used to store bag in the session |
int | $updateThreshold | The time to wait between two UPDATED updates |
initialize(array $array)
Initializes the Bag.
Parameters
array | $array |
int getLifetime()
Gets the lifetime that the session cookie was set with.
Return Value
int |
stampNew(int $lifetime = null)
Stamps a new session's metadata.
Parameters
int | $lifetime | Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp. |
string getStorageKey()
Gets the storage key for this bag.
Return Value
string |
int getCreated()
Gets the created timestamp metadata.
Return Value
int | Unix timestamp |
int getLastUsed()
Gets the last used metadata.
Return Value
int | Unix timestamp |
mixed clear()
Clears out data from bag.
Return Value
mixed | Whatever data was contained |
string getName()
Gets this bag's name.
Return Value
string |
setName(string $name)
Sets name.
Parameters
string | $name |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/4.0/Symfony/Component/HttpFoundation/Session/Storage/MetadataBag.html