Public Member Functions |
| __construct ($config, $soap) |
| GetUserSessionVariable ($token, $key) |
| GetUserPersistentVariable ($token, $key) |
| SetUserSessionVariable ($token, $key, $value) |
| SetUserPersistentVariable ($token, $key, $value) |
| SetUserSessionVariables ($token, $variables) |
| SetUserPersistentVariables ($token, $variables) |
| GetUserSessionVariables ($token) |
| GetUserPersistentVariables ($token) |
| GetServerVariable ($token, $key) |
| GetServerVariables ($token) |
| SetServerVariables ($token, $variables) |
| SetServerVariable ($token, $key, $value) |
Data Fields |
| $soap |
Protected Member Functions |
| GetUserVariable ($token, $key, $persistent=false) |
| SetUserVariable ($token, $key, $value, $persistent=false) |
| SetUserVariables ($token, $variables, $persistent=false) |
| GetUserVariables ($token, $persistent=false) |
| _GetServerVariable ($key) |
| _SetServerVariable ($key, $value) |
| _GetServerVariables () |
| _SetServerVariables ($variables) |
Protected Attributes |
| $config = null |
Constructor & Destructor Documentation
Member Function Documentation
Fetch the value of a variable saved in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
- Parameters:
-
string | $key | The variable name (255 characters max) |
- Returns:
- string The value of the variable protected
Fetch the list of server variables (WITHOUT CHECKING THE SESSION TOKEN)
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Pair[] List of variables protected
Save a variable in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
- Parameters:
-
string | $token | Session identifier |
string | $key | Variable name (255 characters max) |
string | $value | Value |
- Returns:
- boolean protected
Set all server variables at once (WITHOUT CHECKING THE SESSION TOKEN)
- Parameters:
-
string | $token | The session identifier |
| Pair[] | $variables The list of variables |
- Returns:
- boolean protected
Fetch the value of a variable saved in the server's persistent storage
- Parameters:
-
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
- Returns:
- string The value of the variable
Fetch the list of server variables
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Pair[] List of variables
Fetch the value of a variable saved in the user's session
- Parameters:
-
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
- Returns:
- string The value of the variable
Fetch the list of user's persistent variables
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Pair[] List of variables
Fetch the value of a variable saved in the user's session
- Parameters:
-
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
- Returns:
- string The value of the variable
Fetch the list of user's session variables
- Parameters:
-
string | $token | The session identifier |
- Returns:
- Pair[] List of variables
Fetch the value of a variable saved either in the user's session either in his/herpersistent storage
- Parameters:
-
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 |
- Returns:
- string The value of the variable
Fetch the list of user's session/persistent variables
- Parameters:
-
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 |
- Returns:
- Pair[] The value of the variable
Save a variable in the server's persistent storage
- Parameters:
-
string | $token | Session identifier |
string | $key | Variable name (255 characters max) |
string | $value | Value |
- Returns:
- boolean
Set all server variables at once
- Parameters:
-
string | $token | The session identifier |
| Pair[] | $variables The list of variables |
- Returns:
- boolean
Save a variable in the user's persistent storage
- Parameters:
-
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
string | $value | The variable's value |
- Returns:
- boolean
Set all user's persistent variables at once
- Parameters:
-
string | $token | The session identifier |
| Pair[] | $variables The list of variables |
- Returns:
- boolean
Save a variable in the user's session
- Parameters:
-
string | $token | The session identifier |
string | $key | The variable name (255 characters max) |
string | $value | The variable's value |
- Returns:
- boolean
Set all user's session variables at once
- Parameters:
-
string | $token | The session identifier |
| Pair[] | $variables The list of variables |
- Returns:
- boolean
SetUserVariable |
( |
$ |
token, |
|
|
$ |
key, |
|
|
$ |
value, |
|
|
$ |
persistent = false |
|
) |
| [protected] |
Save a variable in the user's session
- Parameters:
-
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 |
- Returns:
- boolean
Save all variables in the user's session or persistent storage at once
- Parameters:
-
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 |
- Returns:
- boolean
Field Documentation
$config = null [protected] |
The documentation for this class was generated from the following file: