Dataface_ConfigTool Class Reference

Public Member Functions
	Dataface_ConfigTool ()
&	loadConfig ($type=null, $table=null)
&	loadConfigFromINI ($type=null, $tablename='__global__')
	apc_save ()
	apc_load ()
	apc_hash ()
	loadAllConfigFromINI ()
	loadAllConfig ()
	parse_ini_file ($path, $sections=false)
	buildConfigQuery ($path, $username, $lang, $where=null)
	createConfigTable ()
	setConfigParam ($file, $section, $key, $value, $username=null, $lang=null, $priority=5)
	clearConfigParam ($file, $section, $key, $value, $username=null, $lang=null)
Static Public Member Functions
static &	getInstance ()
Data Fields
	$configTypes = array('actions','fields','relationships','valuelists','tables','lang','metadata')
	$rawConfig = array()
	$config = array()
	$configLoaded = false
	$iniLoaded = array()
	$configTableName = 'dataface__config'
	$nameLookup = array('actions'=>array(), 'fields'=>array(), 'table'=>array(), 'relationships'=>array(), 'valuelists'=>array(),'lang'=>array())

---

Detailed Description

Author: Steve Hannah <shannah@sfu.ca> Created: March 23, 2006 A tool to manage application configuration. This can read and write configuration files and transfer configuration information from database format to ini files and vice versa.

Definition at line 33 of file ConfigTool.php.

---

Member Function Documentation

apc_hash

(

)

Definition at line 272 of file ConfigTool.php.

apc_load

(

)

Definition at line 265 of file ConfigTool.php.

apc_save

(

)

Definition at line 257 of file ConfigTool.php.

buildConfigQuery	(	$	path,
		$	username,
		$	lang,
		$	where = null
	)

Definition at line 390 of file ConfigTool.php.

clearConfigParam	(	$	file,
		$	section,
		$	key,
		$	value,
		$	username = null,
		$	lang = null
	)

Definition at line 415 of file ConfigTool.php.

createConfigTable

(

)

Definition at line 405 of file ConfigTool.php.

Dataface_ConfigTool

(

)

Definition at line 42 of file ConfigTool.php.

static& getInstance

(

)

[static]

Definition at line 52 of file ConfigTool.php.

loadAllConfig

(

)

Definition at line 301 of file ConfigTool.php.

loadAllConfigFromINI

(

)

Scours the tables directory to load all configuration information from the ini files.

Definition at line 282 of file ConfigTool.php.

& loadConfig	(	$	type = null,
		$	table = null
	)

Loads configuration information of particular type for a particular table.

Parameters:

$type	The type of config information to load. (e.g., 'actions', 'fields', 'table', 'relationships')
$table	The name of the table for which to load configuration info.

Returns:

A 2-dimensional associative array modelling the configuration information that has been returned.

Definition at line 66 of file ConfigTool.php.

& loadConfigFromINI	(	$	type = null,
		$	tablename = '__global__'
	)

Loads configuration information from an INI file.

Parameters:

$type	The type of configuration information to load: e.g., actions, relationships, valuelists, fields, etc..
$tablename	The name of the table for which to load the configuration information.

Returns:

Associative array of configuration options in the same form as they would be returned by parse_ini_file().

Definition at line 79 of file ConfigTool.php.

parse_ini_file	(	$	path,
		$	sections = false
	)

Definition at line 319 of file ConfigTool.php.

setConfigParam	(	$	file,
		$	section,
		$	key,
		$	value,
		$	username = null,
		$	lang = null,
		$	priority = 5
	)

Definition at line 410 of file ConfigTool.php.

---

Field Documentation

$config = array()

Definition at line 37 of file ConfigTool.php.

$configLoaded = false

Definition at line 38 of file ConfigTool.php.

$configTableName = 'dataface__config'

Definition at line 40 of file ConfigTool.php.

$configTypes = array('actions','fields','relationships','valuelists','tables','lang','metadata')

Definition at line 35 of file ConfigTool.php.

$iniLoaded = array()

Definition at line 39 of file ConfigTool.php.

$nameLookup = array('actions'=>array(), 'fields'=>array(), 'table'=>array(), 'relationships'=>array(), 'valuelists'=>array(),'lang'=>array())

Array to lookup the name of an entity based on its ID.

Definition at line 50 of file ConfigTool.php.

$rawConfig = array()

Definition at line 36 of file ConfigTool.php.

---

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

• Dataface/ConfigTool.php