Class Config_File

Config file reading class

Package: Smarty
Copyright: Copyright: 2001-2005 New Digital Group, Inc.
Author: Andrei Zmievski andrei@php.net
Located at lass/smarty/Config_File.class.php

Methods summary
`public`	# `__construct( string $config_path = NULL )` Constructs a new config file class. Constructs a new config file class. Parameters `$config_path` (optional) path to the config files
`public`	# `set_path( string $config_path )` Set the path where configuration files can be found. Set the path where configuration files can be found. Parameters `$config_path` path to the config files
`public string\|array`	# `get( string $file_name, string $section_name = NULL, string $var_name = NULL )` Retrieves config info based on the file, section, and variable name. Retrieves config info based on the file, section, and variable name. Parameters `$file_name` config file to get info for `$section_name` (optional) section to get info for `$var_name` (optional) variable to get info for Returns string\|array a value or array of values Used by `Config_File::get_key()` retrieves information from config file and returns it
`public string\|array &`	# `get_key( $config_key )` Retrieves config info based on the key. Retrieves config info based on the key. Parameters `$config_key` config key (filename/section/var) Returns string\|array same as get() Uses `Config_File::get()` retrieves information from config file and returns it
`public array`	# `get_file_names( )` Get all loaded config file names. Get all loaded config file names. Returns array an array of loaded config file names
`public array`	# `get_section_names( string $file_name )` Get all section names from a loaded file. Get all section names from a loaded file. Parameters `$file_name` config file to get section names from Returns array an array of section names from the specified file
`public array`	# `get_var_names( string $file_name, string $section = NULL )` Get all global or section variable names. Get all global or section variable names. Parameters `$file_name` config file to get info for `$section` $section_name (optional) section to get info for Returns array an array of variables names from the specified file/section
`public`	# `clear( string $file_name = NULL )` Clear loaded config data for a certain file or all files. Clear loaded config data for a certain file or all files. Parameters `$file_name` file to clear config data for
`public`	# `load_file( string $file_name, boolean $prepend_path = true )` Load a configuration file manually. Load a configuration file manually. Parameters `$file_name` file name to load `$prepend_path` whether current config path should be prepended to the filename
`public`	# `set_file_contents( string $config_file, string $contents )` Store the contents of a file manually. Store the contents of a file manually. Parameters `$config_file` file name of the related contents `$contents` the file-contents to parse
`public`	# `parse_contents( string $contents )` parse the source of a configuration file manually. parse the source of a configuration file manually. Parameters `$contents` the file-contents to parse
`public`	# `_set_config_var( array & $container, string $var_name, mixed $var_value, boolean $booleanize )` Parameters `$container` $container `$var_name` `$var_value` `$booleanize` determines whether $var_value is converted to to true/false
`public`	# `_trigger_error_msg( string $error_msg, integer $error_type = E_USER_WARNING )` Parameters `$error_msg` `$error_type` one of Uses trigger_error() creates a PHP warning/error

Properties summary
`public boolean`	`$overwrite` Controls whether variables with the same name overwrite each other. Controls whether variables with the same name overwrite each other.	# `true`
`public boolean`	`$booleanize` Controls whether config values of on/true/yes and off/false/no get converted to boolean values automatically. Controls whether config values of on/true/yes and off/false/no get converted to boolean values automatically.	# `true`
`public boolean`	`$read_hidden` Controls whether hidden config sections/vars are read from the file. Controls whether hidden config sections/vars are read from the file.	# `true`
`public boolean`	`$fix_newlines` Controls whether or not to fix mac or dos formatted newlines. If set to true, \r or \r\n will be changed to \n. Controls whether or not to fix mac or dos formatted newlines. If set to true, \r or \r\n will be changed to \n.	# `true`
`public string`	`$_config_path`	# `""`
`public array`	`$_config_data`	# `array()`