Collaboration diagram for ApplicationParameterManager:

Static Public Member Functions
static	resetCache ()

static	getUserParameterValue ($application, $parameterName, $userId=null)

static	getUserParameterDefaultValue ($application, $parameterName)

static	getCommonParameterValue ($application, $parameterName)

static	setUserParameterValue ($application, $parameterName, $value, $userId=null, $check=true)

static	setUserParameterDefaultValue ($application, $parameterName, $value)

static	setCommonParameterValue ($application, $parameterName, $value)

static	getParameterValue ($application, $parameterName)

static	setParameterValue ($application, $parameterName, $value)

static	getScopedParameterValue ($parameter)

static	getParameter ($application, $parameterName)

static	getParameters ($application)

static	_catchDeprecatedGlobalParameter ($parameterName)

Data Fields
const	CURRENT_APPLICATION = '##CURRENT APPLICATION##'

const	GLOBAL_PARAMETER = '##GLOBAL PARAMETER##'

Detailed Description

Manage application parameters Set and get application parameters

See Also: ApplicationParameterManager

Definition at line 14 of file Class.ApplicationParameterManager.php.

Member Function Documentation

static _catchDeprecatedGlobalParameter ( $parameterName )

static

Internal function to catch requests for deprecated parameters

Parameters

$parameterName

Returns: null|string return null value if the parameter is not deprecated and the caller should follow on querying the value on its own, or a non-null value containing the value the caller should use instead of querying the value on its own.

Definition at line 460 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static getCommonParameterValue	(	$application,
		$parameterName
	)

static

Return the value of a non-user (common) parameter

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter

Returns: string the value of a common parameter (USER="N")

Definition at line 90 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static getParameter	(	$application,
		$parameterName
	)

static

Get a parameter object (object that describe the parameter)

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: object the object parameter

Definition at line 313 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static getParameters ( $application )

static

Get the parameters objects of an application

Parameters

string | int | Application $application logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: object the object parameter

Definition at line 343 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static getParameterValue	(	$application,
		$parameterName
	)

static

Get a parameter value in the database

Api:

Get parameter in the database

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter

Returns: string value of the parameter

Definition at line 236 of file Class.ApplicationParameterManager.php.

static getScopedParameterValue ( $parameter )

static

Get a parameter value in the scope (use cache, session cache, volatile param)

Api:: Get the value of the parameter in the scope of the current action

Parameters

$parameter

Returns: string value of the parameter

Definition at line 298 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static getUserParameterDefaultValue	(	$application,
		$parameterName
	)

static

Return the default value of a user parameter

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter

Returns: string the value of a common parameter (USER="Y")

Definition at line 76 of file Class.ApplicationParameterManager.php.

static getUserParameterValue	(	$application,
		$parameterName,
		$userId = `null`
	)

static

Return the value of a user parameter

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter
null \| int	$userId	user login or account id, use it if you want the value for another user

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: string|null the value of a user parameter (USER="Y") or if not exist

Definition at line 43 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static resetCache ( )

static

for internal purpose only

Definition at line 27 of file Class.ApplicationParameterManager.php.

static setCommonParameterValue	(	$application,
		$parameterName,
		$value
	)

static

Set the common parameter default value

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter
string	$value	value of the parameter

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: void

Definition at line 190 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

static setParameterValue	(	$application,
		$parameterName,
		$value
	)

static

Set a parameter value

Api:

Set a parameter value

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter
string	$value	value of the parameter

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: void|string error string or void

Definition at line 274 of file Class.ApplicationParameterManager.php.

static setUserParameterDefaultValue	(	$application,
		$parameterName,
		$value
	)

static

Set the user parameter default value

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter
string	$value	value of the parameter

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: void

Definition at line 174 of file Class.ApplicationParameterManager.php.

static setUserParameterValue	(	$application,
		$parameterName,
		$value,
		$userId = `null`,
		$check = `true`
	)

static

Set the user parameter value

Parameters

string \| int \| Application	$application	logical name or id or object of the application, you can use ApplicationParameterManager::CURRENT_APPLICATION or ApplicationParameterManager::GLOBAL_PARAMETER
string	$parameterName	logical name of the parameter
string	$value	value of the parameter
null \| int \| string	$userId	user login or account id, use it if you want to set the value for another user
bool	$check

Exceptions

Dcp\ApplicationParameterManager\Exception

Returns: void

Definition at line 126 of file Class.ApplicationParameterManager.php.

Here is the call graph for this function:

Field Documentation

const CURRENT_APPLICATION = '##CURRENT APPLICATION##'

Definition at line 16 of file Class.ApplicationParameterManager.php.

const GLOBAL_PARAMETER = '##GLOBAL PARAMETER##'

Definition at line 17 of file Class.ApplicationParameterManager.php.

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

Class.ApplicationParameterManager.php

Static Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

Field Documentation