Config_File Klassenreferenz

Aufstellung aller Elemente

Öffentliche Methoden
	Config_File ($config_path=NULL)
	set_path ($config_path)
	get ($file_name, $section_name=NULL, $var_name=NULL)
&	get_key ($config_key)
	get_file_names ()
	get_section_names ($file_name)
	get_var_names ($file_name, $section=NULL)
	clear ($file_name=NULL)
	load_file ($file_name, $prepend_path=true)
	set_file_contents ($config_file, $contents)
	parse_contents ($contents)
	_set_config_var (&$container, $var_name, $var_value, $booleanize)
	_trigger_error_msg ($error_msg, $error_type=E_USER_WARNING)
Öffentliche Attribute
	$overwrite = true
	$booleanize = true
	$read_hidden = true
	$fix_newlines = true
	$_config_path = ""
	$_config_data = array()

---

Ausführliche Beschreibung

Definiert in Zeile 38 der Datei Config_File.class.php.

---

Dokumentation der Elementfunktionen

Config_File::_set_config_var	(	&$	container,
		$	var_name,
		$	var_value,
		$	booleanize
	)

#@+ private

Parameter:

	array	&$container
	string	$var_name
	mixed	$var_value
	boolean	$booleanize determines whether $var_value is converted to to true/false

Definiert in Zeile 352 der Datei Config_File.class.php.

Benutzt $booleanize und _trigger_error_msg().

Wird benutzt von parse_contents().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::_trigger_error_msg	(	$	error_msg,
		$	error_type = E_USER_WARNING
	)

trigger_error() creates a PHP warning/error

Parameter:

	string	$error_msg
	integer	$error_type one of

Definiert in Zeile 386 der Datei Config_File.class.php.

Wird benutzt von _set_config_var(), get(), get_section_names(), get_var_names(), load_file() und set_path().

Config_File::clear

(

$

file_name = NULL

)

Clear loaded config data for a certain file or all files.

Parameter:

string

$file_name file to clear config data for

Definiert in Zeile 217 der Datei Config_File.class.php.

Config_File::Config_File

(

$

config_path = NULL

)

#@- Constructs a new config file class.

Parameter:

string

$config_path (optional) path to the config files

Definiert in Zeile 76 der Datei Config_File.class.php.

Benutzt set_path().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::get	(	$	file_name,
		$	section_name = NULL,
		$	var_name = NULL
	)

Retrieves config info based on the file, section, and variable name.

Parameter:

	string	$file_name config file to get info for
	string	$section_name (optional) section to get info for
	string	$var_name (optional) variable to get info for

Rückgabe:

string|array a value or array of values

Definiert in Zeile 112 der Datei Config_File.class.php.

Benutzt _trigger_error_msg() und load_file().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::get_file_names

(

)

Get all loaded config file names.

Rückgabe:

array an array of loaded config file names

Definiert in Zeile 164 der Datei Config_File.class.php.

& Config_File::get_key

(

$

config_key

)

Retrieves config info based on the key.

Parameter:

$file_name

string config key (filename/section/var)

Rückgabe:

string|array same as get() get() retrieves information from config file and returns it

Definiert in Zeile 152 der Datei Config_File.class.php.

Config_File::get_section_names

(

$

file_name

)

Get all section names from a loaded file.

Parameter:

string

$file_name config file to get section names from

Rückgabe:

array an array of section names from the specified file

Definiert in Zeile 176 der Datei Config_File.class.php.

Benutzt _trigger_error_msg().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::get_var_names	(	$	file_name,
		$	section = NULL
	)

Get all global or section variable names.

Parameter:

	string	$file_name config file to get info for
	string	$section_name (optional) section to get info for

Rückgabe:

array an array of variables names from the specified file/section

Definiert in Zeile 195 der Datei Config_File.class.php.

Benutzt _trigger_error_msg().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::load_file	(	$	file_name,
		$	prepend_path = true
	)

Load a configuration file manually.

Parameter:

	string	$file_name file name to load
	boolean	$prepend_path whether current config path should be prepended to the filename

Definiert in Zeile 233 der Datei Config_File.class.php.

Benutzt _trigger_error_msg() und parse_contents().

Wird benutzt von get().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::parse_contents

(

$

contents

)

parse the source of a configuration file manually.

Parameter:

string

$contents the file-contents to parse

Definiert in Zeile 271 der Datei Config_File.class.php.

Benutzt $booleanize und _set_config_var().

Wird benutzt von load_file() und set_file_contents().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::set_file_contents	(	$	config_file,
		$	contents
	)

Store the contents of a file manually.

Parameter:

	string	$config_file file name of the related contents
	string	$contents the file-contents to parse

Definiert in Zeile 260 der Datei Config_File.class.php.

Benutzt parse_contents().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

Config_File::set_path

(

$

config_path

)

Set the path where configuration files can be found.

Parameter:

string

$config_path path to the config files

Definiert in Zeile 88 der Datei Config_File.class.php.

Benutzt _trigger_error_msg().

Wird benutzt von Config_File().

Hier ist ein Graph der zeigt, was diese Funktion aufruft:

---

Dokumentation der Datenelemente

Config_File::$_config_data = array()

Definiert in Zeile 68 der Datei Config_File.class.php.

Config_File::$_config_path = ""

#@- private

Definiert in Zeile 67 der Datei Config_File.class.php.

Config_File::$booleanize = true

Controls whether config values of on/true/yes and off/false/no get converted to boolean values automatically.

Definiert in Zeile 52 der Datei Config_File.class.php.

Wird benutzt von _set_config_var() und parse_contents().

Config_File::$fix_newlines = true

Controls whether or not to fix mac or dos formatted newlines. If set to true, or
will be changed to
.

Definiert in Zeile 63 der Datei Config_File.class.php.

Config_File::$overwrite = true

Controls whether variables with the same name overwrite each other.

Definiert in Zeile 46 der Datei Config_File.class.php.

Config_File::$read_hidden = true

Controls whether hidden config sections/vars are read from the file.

Definiert in Zeile 57 der Datei Config_File.class.php.

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• libs/Config_File.class.php