Methods

Public

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

__get()

Magic get for store and flash as a temporary measure.

add()

Appends a normal value to a key; this will start the session if needed.

addFlash()

Appends a flash value to a key; this will start the session if needed.

delete()

Deletes a key from the store, removing it entirely.

deleteFlash()

Deletes a flash key, removing it entirely.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

get()

Gets a normal value by key, or an alternative default value if the key does not exist.

getClass()

Gets the current class segment for $_SESSION.

getFlash()

Gets a flash value by key, thereby removing the value.

has()

Whether or not the session currently has a particular data key stored.

hasFlash()

Whether or not the session currently has a particular flash key stored.

isLoaded()

Tells if the session segment is loaded or not.

isStarted()

Has a session been started yet?

lazyStart()

Lazy-start the session (i.e., only if a session cookie from the client already exists).

load()

Loads the session segment with store and flash values for the current class.

locale()

Looks up class-specific locale strings based on a key.

regenerateId()

Regenerates the session ID.

reset()

Resets (clears) all normal keys and values.

resetAll()

Resets both "normal" and "flash" values.

resetFlash()

Resets (clears) all flash keys and values.

set()

Sets a normal value by key; this will start the session if needed.

setClass()

Sets the class segment for $_SESSION; unloads existing store and flash values.

setFlash()

Sets a flash value by key; this will start the session if needed.

start()

Starts the session; automatically sends a P3P header if one is defined (and it is, by default).

Protected

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_exception()

Convenience method for returning exceptions with localized text.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_postConstruct()

Post-construction tasks to complete object construction.

_preConfig()

A hook that activates before _buildConfig() in the constructor.

Private

None.