ZurmoConfigurationUtil Class Reference

Static Public Member Functions

static getForCurrentUserByModuleName ($moduleName, $key, $cache=true)
static getByModuleName ($moduleName, $key, $cache=true)
static getByUserAndModuleName ($user, $moduleName, $key, $cache=true)
static setForCurrentUserByModuleName ($moduleName, $key, $value, $cache=true)
static setByModuleName ($moduleName, $key, $value, $cache=true)
static setByUserAndModuleName ($user, $moduleName, $key, $value, $cache=true)

Static Protected Member Functions

static getCacheKey ($moduleName, $configKey, $userId=null)
static getCachedValue ($moduleName, $configKey, $userId=null, $cache=true)
static cacheValue ($moduleName, $configKey, $value, $userId=null, $cache=true)

Detailed Description

Helper Utility to interface with the global and per user configuration settings on a module.

Definition at line 40 of file ZurmoConfigurationUtil.php.


Member Function Documentation

static getForCurrentUserByModuleName ( moduleName,
key,
cache = true 
) [static]

For the current user, retrieve a configuration value by module name and key.

Returns:
configuration value of specified key

Definition at line 46 of file ZurmoConfigurationUtil.php.

static getByModuleName ( moduleName,
key,
cache = true 
) [static]

Retrieve a global configuration value by module name and key.

Returns:
configuration value of specified key

Definition at line 62 of file ZurmoConfigurationUtil.php.

static getByUserAndModuleName ( user,
moduleName,
key,
cache = true 
) [static]

For a specific user, retrieve a configuration value by module name and key.

Returns:
configuration value of specified key

Definition at line 87 of file ZurmoConfigurationUtil.php.

static setForCurrentUserByModuleName ( moduleName,
key,
value,
cache = true 
) [static]

For the current user, set a configuration value by module name and key.

Definition at line 112 of file ZurmoConfigurationUtil.php.

static setByModuleName ( moduleName,
key,
value,
cache = true 
) [static]

Set a global configuration value by module name and key

Definition at line 127 of file ZurmoConfigurationUtil.php.

static setByUserAndModuleName ( user,
moduleName,
key,
value,
cache = true 
) [static]

For a specified user, set a configuration value by module name and key

Definition at line 144 of file ZurmoConfigurationUtil.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Aug 17 07:10:32 2017