Core  3.2
PHP API documentation
 All Data Structures Namespaces Files Functions Variables Pages
ParameterManager Class Reference
+ Collaboration diagram for ParameterManager:

Static Public Member Functions

static resetCache ()
 
static getParameter ($name)
 
static getApplicationParameter ($appName, $name)
 
static setGlobalParameter ($name, $value)
 
static setApplicationParameter ($appName, $name, $value)
 
static setUserApplicationParameter ($appName, $name, $value, $userId=null)
 
static setGlobalUserParameter ($name, $value, $userId=null)
 

Detailed Description

Manage application parameters Set and get application parameters

See Also
ApplicationParameterManager
Deprecated:
use ApplicationParameterManager instead

Definition at line 19 of file Class.ParameterManager.php.

Member Function Documentation

static getApplicationParameter (   $appName,
  $name 
)
static

get a specific value for an application get user value for current user if it is a user parameter

Deprecated:
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparamter
Returns
string|null value of parameter (null if parameter not exists)

Definition at line 60 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static getParameter (   $name)
static

return current value for a parameter these values can depend of current user when it is a user parameter

Deprecated:
use ApplicationParameterManager instead
Parameters
string$nameparamter name
Returns
string|null value of parameter (null if parameter not exists)

Definition at line 47 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static resetCache ( )
static

for internal purpose only

Deprecated:
use ApplicationParameterManager instead

Definition at line 34 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static setApplicationParameter (   $appName,
  $name,
  $value 
)
static

set new Value for an application parameter

Deprecated:
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparameter name
string$valuenew value to set
Exceptions
Dcp\PMGT\Exception

Definition at line 108 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static setGlobalParameter (   $name,
  $value 
)
static

set new Value for a global application parameter

Deprecated:
use ApplicationParameterManager instead
Parameters
string$nameparameter name
string$valuenew value to set
Exceptions
Dcp\PMGT\Exception

Definition at line 89 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static setGlobalUserParameter (   $name,
  $value,
  $userId = null 
)
static

Update a global user parameter value

Deprecated:
use ApplicationParameterManager instead
Parameters
string$nameparameter name (must be declared as user and global)
string$valuenew value to set
int$userIduser account identificator (if null use current user)
Exceptions
Dcp\PMGT\Exception

Definition at line 167 of file Class.ParameterManager.php.

+ Here is the call graph for this function:

static setUserApplicationParameter (   $appName,
  $name,
  $value,
  $userId = null 
)
static

Update a user parameter value

Deprecated:
use ApplicationParameterManager instead
Parameters
string$appNameapplication name
string$nameparameter name (must be declared as user)
string$valuenew value to set
int$userIduser account identificator (if null use current user)
Exceptions
Dcp\PMGT\Exception

Definition at line 138 of file Class.ParameterManager.php.

+ Here is the call graph for this function:


The documentation for this class was generated from the following file:
← centre documentaire © anakeen