Docs For Class SessionManager

Description

Manages session variables

author: Marcos Pont <mpont@users.sourceforge.net>
version: $Revision$
usedby: HttpRequest

Located in /core/session/SessionManager.class.php (line 37)

PHP2Go
   |
   --SessionManager

Method Summary

static void destroy ()

static SessionManager &getInstance ()

static mixed getObjectProperty (string $qualifiedName)

string getSessionId ()

string getSessionName ()

string getSessionSavePath ()

mixed getValue (string $name, [mixed $fallback = FALSE])

bool isRegistered (string $var)

void register (string $name, mixed $value)

mixed setValue (string $name, mixed $value)

void unregister (string $name)

Methods

static method destroy (line 168)

Destroys all session variables and kills the current active session

static void destroy ()

static method getInstance (line 45)

Get the singleton of the SessionManager class

static SessionManager &getInstance ()

static method getObjectProperty (line 64)

Read a property of a SessionObject instance stored in the session scope

The $qualifiedName variable must be composed by the name of the session object plus the name of the property, separated by a double colon sign.

usedby: HttpRequest::getVar()

static mixed getObjectProperty (string $qualifiedName)

string $qualifiedName: Qualified name

getSessionId (line 79)

Get current session ID

string getSessionId ()

getSessionName (line 88)

Get current session cookie name

string getSessionName ()

getSessionSavePath (line 97)

Get current session save path

string getSessionSavePath ()

getValue (line 118)

Get the value of a session variable

mixed getValue (string $name, [mixed $fallback = FALSE])

string $name: Variable name
mixed $fallback: Fallback value

isRegistered (line 107)

Check if a given variable exists in the session scope

bool isRegistered (string $var)

string $var: Variable name

register (line 146)

Create or replace a session variable

void register (string $name, mixed $value)

string $name: Variable name
mixed $value: Variable value

setValue (line 131)

Create or replace a session variable

return: Old value, if existent

mixed setValue (string $name, mixed $value)

string $name: Variable name
mixed $value: Variable value

unregister (line 155)

Removes a variable from the session scope

void unregister (string $name)

string $name: Variable name

Inherited Methods

Inherited From PHP2Go

PHP2Go::PHP2Go()
PHP2Go::equals()
PHP2Go::generateUniqueId()
PHP2Go::getClassName()
PHP2Go::getConfigVal()
PHP2Go::getLangVal()
PHP2Go::getObjectName()
PHP2Go::getParentName()
PHP2Go::hasDestructor()
PHP2Go::hashCode()
PHP2Go::isA()
PHP2Go::isSubclassOf()
PHP2Go::logError()
PHP2Go::raiseError()
PHP2Go::registerDestructor()
PHP2Go::registerShutdownFunc()
PHP2Go::retrieve()
PHP2Go::store()
PHP2Go::__toString()