Class tariqaSession

Description

Located in /Tariqa.code/tariqaSession.class.php (line 2)

Tariqa
   |
   --tariqaSession
Variable Summary
array $config
boolean $soap
Method Summary
Tariqa __construct ( $config,  $soap)
string|false CheckToken (string $token)
string GetServerVariable (string $token, string $key)
Pair[] GetServerVariables (string $token)
string GetUserPersistentVariable (string $token, string $key)
Pair[] GetUserPersistentVariables (string $token)
string GetUserSessionVariable (string $token, string $key)
Pair[] GetUserSessionVariables (string $token)
string GetUserVariable (string $token, string $key, [boolean $persistent = false])
Pair[] GetUserVariables (string $token, [boolean $persistent = false])
boolean SetServerVariable (string $token, string $key, string $value)
boolean SetServerVariables (string $token, Pair[] $variables)
boolean SetUserPersistentVariable (string $token, string $key, string $value)
boolean SetUserPersistentVariables (string $token, Pair[] $variables)
boolean SetUserSessionVariable (string $token, string $key, string $value)
boolean SetUserSessionVariables (string $token, Pair[] $variables)
boolean SetUserVariable (string $token, string $key, string $value, [boolean $persistent = false])
boolean SetUserVariables (string $token, Pair[] $variables, [boolean $persistent = false])
string _GetServerVariable (string $key)
Pair[] _GetServerVariables (string $token)
boolean _SetServerVariable (string $key, string $value, string $token)
boolean _SetServerVariables (Pair[] $variables, string $token)
Variables
array $config = null (line 7)

Configuration array

  • access: protected
boolean $soap (line 13)

The class is called using SOAP

  • access: public
Methods
Constructor __construct (line 20)

Constructs a tariqaThemes Object

  • access: public
Tariqa __construct ( $config,  $soap)
  • $config
  • $soap
CheckToken (line 30)

Checks the validity of a token

  • return: Returns false on error, the userId in case of success
  • access: protected
string|false CheckToken (string $token)
  • string $token: The session identifier
GetServerVariable (line 602)

Fetch the value of a variable saved in the server's persistent storage

  • return: The value of the variable
  • access: public
string GetServerVariable (string $token, string $key)
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
GetServerVariables (line 616)

Fetch the list of server variables

  • return: List of variables
  • access: public
Pair[] GetServerVariables (string $token)
  • string $token: The session identifier
GetUserPersistentVariable (line 166)

Fetch the value of a variable saved in the user's session

  • return: The value of the variable
  • access: public
string GetUserPersistentVariable (string $token, string $key)
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
GetUserPersistentVariables (line 387)

Fetch the list of user's persistent variables

  • return: List of variables
  • access: public
Pair[] GetUserPersistentVariables (string $token)
  • string $token: The session identifier
GetUserSessionVariable (line 157)

Fetch the value of a variable saved in the user's session

  • return: The value of the variable
  • access: public
string GetUserSessionVariable (string $token, string $key)
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
GetUserSessionVariables (line 379)

Fetch the list of user's session variables

  • return: List of variables
  • access: public
Pair[] GetUserSessionVariables (string $token)
  • string $token: The session identifier
GetUserVariable (line 177)

Fetch the value of a variable saved either in the user's session either in his/herpersistent storage

  • return: The value of the variable
  • access: protected
string GetUserVariable (string $token, string $key, [boolean $persistent = false])
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
  • boolean $persistent: If false (default) look for the value in the session, otherwise look in the persistent data of the user
GetUserVariables (line 397)

Fetch the list of user's session/persistent variables

  • return: The value of the variable
  • access: protected
Pair[] GetUserVariables (string $token, [boolean $persistent = false])
  • string $token: The session identifier
  • boolean $persistent: If false (default) look for the value in the session, otherwise look in the persistent data of the user
SetServerVariable (line 647)

Save a variable in the server's persistent storage

  • access: public
boolean SetServerVariable (string $token, string $key, string $value)
  • string $token: Session identifier
  • string $key: Variable name (255 characters max)
  • string $value: Value
SetServerVariables (line 631)

Set all server variables at once

  • access: public
boolean SetServerVariables (string $token, Pair[] $variables)
  • string $token: The session identifier
  • Pair[] $variables: The list of variables
SetUserPersistentVariable (line 237)

Save a variable in the user's persistent storage

  • access: public
boolean SetUserPersistentVariable (string $token, string $key, string $value)
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
  • string $value: The variable's value
SetUserPersistentVariables (line 301)

Set all user's persistent variables at once

  • access: public
boolean SetUserPersistentVariables (string $token, Pair[] $variables)
  • string $token: The session identifier
  • Pair[] $variables: The list of variables
SetUserSessionVariable (line 227)

Save a variable in the user's session

  • access: public
boolean SetUserSessionVariable (string $token, string $key, string $value)
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
  • string $value: The variable's value
SetUserSessionVariables (line 292)

Set all user's session variables at once

  • access: public
boolean SetUserSessionVariables (string $token, Pair[] $variables)
  • string $token: The session identifier
  • Pair[] $variables: The list of variables
SetUserVariable (line 249)

Save a variable in the user's session

  • access: protected
boolean SetUserVariable (string $token, string $key, string $value, [boolean $persistent = false])
  • string $token: The session identifier
  • string $key: The variable name (255 characters max)
  • string $value: The variable's value
  • boolean $persistent: If false (default) look for the value in the session, otherwise look in the persistent data of the user
SetUserVariables (line 312)

Save all variables in the user's session or persistent storage at once

  • access: protected
boolean SetUserVariables (string $token, Pair[] $variables, [boolean $persistent = false])
  • string $token: The session identifier
  • Pair[] $variables: The list of variables
  • boolean $persistent: If false (default) look for the value in the session, otherwise look in the persistent data of the user
_GetServerVariable (line 436)

Fetch the value of a variable saved in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)

  • return: The value of the variable
  • access: protected
string _GetServerVariable (string $key)
  • string $key: The variable name (255 characters max)
_GetServerVariables (line 513)

Fetch the list of server variables (WITHOUT CHECKING THE SESSION TOKEN)

  • return: List of variables
  • access: protected
Pair[] _GetServerVariables (string $token)
  • string $token: The session identifier
_SetServerVariable (line 478)

Save a variable in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)

  • access: protected
boolean _SetServerVariable (string $key, string $value, string $token)
  • string $token: Session identifier
  • string $key: Variable name (255 characters max)
  • string $value: Value
_SetServerVariables (line 543)

Set all server variables at once (WITHOUT CHECKING THE SESSION TOKEN)

  • access: protected
boolean _SetServerVariables (Pair[] $variables, string $token)
  • string $token: The session identifier
  • Pair[] $variables: The list of variables

Documentation generated on Thu, 10 Dec 2009 15:21:51 +0100 by phpDocumentor 1.4.1