Constructs a tariqaThemes Object
Tariqa
__construct
(
$config,
$soap)
Checks the validity of a token
string|false
CheckToken
(string $token)
-
string
$token: The session identifier
Fetch the value of a variable saved in the server's persistent storage
string
GetServerVariable
(string $token, string $key)
-
string
$token: The session identifier
-
string
$key: The variable name (255 characters max)
Fetch the list of server variables
Pair[]
GetServerVariables
(string $token)
-
string
$token: The session identifier
Fetch the value of a variable saved in the user's session
string
GetUserPersistentVariable
(string $token, string $key)
-
string
$token: The session identifier
-
string
$key: The variable name (255 characters max)
Fetch the list of user's persistent variables
Pair[]
GetUserPersistentVariables
(string $token)
-
string
$token: The session identifier
Fetch the value of a variable saved in the user's session
string
GetUserSessionVariable
(string $token, string $key)
-
string
$token: The session identifier
-
string
$key: The variable name (255 characters max)
Fetch the list of user's session variables
Pair[]
GetUserSessionVariables
(string $token)
-
string
$token: The session identifier
Fetch the value of a variable saved either in the user's session either in his/herpersistent storage
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
Fetch the list of user's session/persistent variables
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
Save a variable in the server's persistent storage
boolean
SetServerVariable
(string $token, string $key, string $value)
-
string
$token: Session identifier
-
string
$key: Variable name (255 characters max)
-
string
$value: Value
Set all server variables at once
boolean
SetServerVariables
(string $token, Pair[] $variables)
-
string
$token: The session identifier
-
Pair[]
$variables: The list of variables
Save a variable in the user's persistent storage
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
Set all user's persistent variables at once
boolean
SetUserPersistentVariables
(string $token, Pair[] $variables)
-
string
$token: The session identifier
-
Pair[]
$variables: The list of variables
Save a variable in the user's session
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
Set all user's session variables at once
boolean
SetUserSessionVariables
(string $token, Pair[] $variables)
-
string
$token: The session identifier
-
Pair[]
$variables: The list of variables
Save a variable in the user's session
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
Save all variables in the user's session or persistent storage at once
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
Fetch the value of a variable saved in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
string
_GetServerVariable
(string $key)
-
string
$key: The variable name (255 characters max)
Fetch the list of server variables (WITHOUT CHECKING THE SESSION TOKEN)
Pair[]
_GetServerVariables
(string $token)
-
string
$token: The session identifier
Save a variable in the server's persistent storage (WITHOUT CHECKING THE SESSION TOKEN)
boolean
_SetServerVariable
(string $key, string $value, string $token)
-
string
$token: Session identifier
-
string
$key: Variable name (255 characters max)
-
string
$value: Value
Set all server variables at once (WITHOUT CHECKING THE SESSION TOKEN)
boolean
_SetServerVariables
(Pair[] $variables, string $token)
-
string
$token: The session identifier
-
Pair[]
$variables: The list of variables