68 Classifieds API

boolean $fix_newlines = true (line 63)

Controls whether or not to fix mac or dos formatted newlines.

Options If set to true, \r or \r\n will be changed to \n.

boolean $read_hidden = true (line 57)

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

Options

Constructor Config_File (line 76)

Constructs a new config file class.

• string $config_path: (optional) path to the config files

get (line 112)

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

• return: a value or array of values
• usedby: Config_File::get_key() - retrieves information from config file and returns it

• 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

get_key (line 152)

Retrieves config info based on the key.

• return: same as get()
• uses: Config_File::get() - retrieves information from config file and returns it

• $file_name $config_key: string config key (filename/section/var)

get_var_names (line 195)

Get all global or section variable names.

• return: an array of variables names from the specified file/section

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

parse_contents (line 271)

parse the source of a configuration file manually.

• string $contents: the file-contents to parse

set_path (line 88)

Set the path where configuration files can be found.

• string $config_path: path to the config files