class MetadataBag implements SessionBagInterface

Metadata container.

Adds metadata to the session.

Constants

CREATED

UPDATED

LIFETIME

Methods

__construct(string $storageKey = '_sf2_meta', int $updateThreshold)

No description

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

at line line 60
__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

at line line 69
initialize(array $array)

Initializes the Bag.

Parameters

array $array

at line line 90
int getLifetime()

Gets the lifetime that the session cookie was set with.

Return Value

int

at line line 103
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.

at line line 111
string getStorageKey()

Gets the storage key for this bag.

Return Value

string

at line line 121
int getCreated()

Gets the created timestamp metadata.

Return Value

int Unix timestamp

at line line 131
int getLastUsed()

Gets the last used metadata.

Return Value

int Unix timestamp

at line line 139
mixed clear()

Clears out data from bag.

Return Value

mixed Whatever data was contained

at line line 147
string getName()

Gets this bag's name.

Return Value

string

at line line 157
setName(string $name)

Sets name.

Parameters

string $name