JConfig Class Reference

Inheritance diagram for JConfig:

[legend]Collaboration diagram for JConfig:

[legend]List of all members.

Public Member Functions
	JConfig ($scope=CONFIG_SYSTEM_SCOPE, $id=0)
	_UpdateData ()
&	GetInstance ($scope=CONFIG_SYSTEM_SCOPE, $id=0)
	GetKeys ()
	GetKeysValues ()
	GetValue ($key, $default=null)
	SetValue ($keys, $user=true, $group=false)
Public Attributes
	$scope
	The scope of the config.
	$idU
	The id of the user.
	$idG
	The id of the group.
	$idM
	The id of the module.
	$config
	Array that stores the config values.

---

Detailed Description

Class that implements the logic of the configuration system. It will access the data through ConfigCache, process them and gives them to the user.

It can be instantiated to return either the system config or a concrete module config.

Definition at line 20 of file JConfig.class.php.

---

Constructor & Destructor Documentation

JConfig::JConfig (  $  scope = CONFIG_SYSTEM_SCOPE, $  id = 0 )

Access to the ConfigCache and stores the data. It is not intended to be used directly but through the static method GetInstance. Parameters: scope  The scope of the config. It can be either CONFIG_SYSTEM_SCOPE or CONFIG_MODULE_SCOPE. id  (optional) The id of the module. Definition at line 37 of file JConfig.class.php. References $scope, JSystem::GetCurrentGroup(), JSystem::GetCurrentUser(), and JSystem::IsError(). Referenced by GetInstance().

---

Member Function Documentation

JConfig::_UpdateData (   )

Access to ConfigCache and updates the data stored in the object. Definition at line 67 of file JConfig.class.php. References ConfigCache::GetInstance().

& JConfig::GetInstance (  $  scope = CONFIG_SYSTEM_SCOPE, $  id = 0 )

Definition at line 126 of file JConfig.class.php. References $scope, and JConfig(). Referenced by Module::GetConfig(), JSystem::GetConfig(), Module::SetConfig(), and JSystem::SetConfig().

JConfig::GetKeys (   )

Definition at line 138 of file JConfig.class.php.

JConfig::GetKeysValues (   )

Definition at line 143 of file JConfig.class.php.

JConfig::GetValue (  $  key, $  default = null )

Definition at line 148 of file JConfig.class.php.

JConfig::SetValue (  $  keys, $  user = true, $  group = false )

Definition at line 156 of file JConfig.class.php. References ConfigCache::GetInstance().

---

Member Data Documentation

JConfig::$config

Array that stores the config values. Definition at line 27 of file JConfig.class.php.

JConfig::$idG

The id of the group. Definition at line 24 of file JConfig.class.php.

JConfig::$idM

The id of the module. Definition at line 25 of file JConfig.class.php.

JConfig::$idU

The id of the user. Definition at line 23 of file JConfig.class.php.

JConfig::$scope

The scope of the config. Definition at line 22 of file JConfig.class.php. Referenced by GetInstance(), and JConfig().

---

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

• JConfig.class.php

---