Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
tariqaSession Class Reference
Inheritance diagram for tariqaSession:
Tariqa

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

__construct ( config,
soap 
)

Constructs a tariqaThemes Object

Returns:
Tariqa

Member Function Documentation

_GetServerVariable ( key) [protected]

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

Parameters:
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable protected
_GetServerVariables ( ) [protected]

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

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables protected
_SetServerVariable ( key,
value 
) [protected]

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

Parameters:
string$tokenSession identifier
string$keyVariable name (255 characters max)
string$valueValue
Returns:
boolean protected
_SetServerVariables ( variables) [protected]

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

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean protected
GetServerVariable ( token,
key 
)

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

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable
GetServerVariables ( token)

Fetch the list of server variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetUserPersistentVariable ( token,
key 
)

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

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable

Fetch the list of user's persistent variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetUserSessionVariable ( token,
key 
)

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

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
Returns:
string The value of the variable

Fetch the list of user's session variables

Parameters:
string$tokenThe session identifier
Returns:
Pair[] List of variables
GetUserVariable ( token,
key,
persistent = false 
) [protected]

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

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
boolean$persistentIf 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
GetUserVariables ( token,
persistent = false 
) [protected]

Fetch the list of user's session/persistent variables

Parameters:
string$tokenThe session identifier
boolean$persistentIf 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
SetServerVariable ( token,
key,
value 
)

Save a variable in the server's persistent storage

Parameters:
string$tokenSession identifier
string$keyVariable name (255 characters max)
string$valueValue
Returns:
boolean
SetServerVariables ( token,
variables 
)

Set all server variables at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean
SetUserPersistentVariable ( token,
key,
value 
)

Save a variable in the user's persistent storage

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
Returns:
boolean
SetUserPersistentVariables ( token,
variables 
)

Set all user's persistent variables at once

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
Returns:
boolean
SetUserSessionVariable ( token,
key,
value 
)

Save a variable in the user's session

Parameters:
string$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
Returns:
boolean
SetUserSessionVariables ( token,
variables 
)

Set all user's session variables at once

Parameters:
string$tokenThe 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$tokenThe session identifier
string$keyThe variable name (255 characters max)
string$valueThe variable's value
boolean$persistentIf false (default) look for the value in the session, otherwise look in the persistent data of the user
Returns:
boolean
SetUserVariables ( token,
variables,
persistent = false 
) [protected]

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

Parameters:
string$tokenThe session identifier
Pair[]$variables The list of variables
boolean$persistentIf 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]

Reimplemented from Tariqa.

$soap

Reimplemented from Tariqa.


The documentation for this class was generated from the following file: