Editing a configuration Config::Config

Config

PEAR Manual


Available Containers

Available Containers -- Supported formats

Available Containers

Apache

Parses and saves Apache configuration files. No options are provided by this container.

GenericConf

Generic configuration files. The equals, comment start and new line characters in the parser can be customised to match your preferred configuration format.

Available Options

Option Data Type Default value Description
"comment" string "#" The character that signifies the start of a comment.
"equals" string ":" The character that separates keys from values.
"newline" string "\" The character that signifies that a value continues across multiple lines.

IniCommented

Parses standard INI files, maintaining comments within the file. No options are available for this container.

IniFile

Parse standard INI files using PHP's in built parse_ini_file(). Does not read in comments. No options are available for this container.

PHPArray

Parses PHP Array structures. Can read from a PHP Source file or from an in memory array. Due to technical limitations, this container does not parse blank lines or comments when reading from a configuration file, therefore any information contained within PHP comments will be lost.

Available Options

Option Data Type Default value Description
"name" string "conf" The name to use for the root configuration variable, both when parsing and writing PHP source files.
"useAttr" boolean TRUE Controls whether attributes are parsed and saved.

Warning

Since config files containing php arrays are just included using the standard php methods, code comments and structure will be lost when saving.

PHPConstants

Parses a set of PHP define() from a PHP source file. Comments are maintained by this container, although blank lines will be lost. There are no options for this container.

XML

Parses a XML file using XML_Parser.

Available Options

Option Data Type Default value Description
"version" string "1.0" The XML version to use.
"encoding" string "ISO-8859-1" The content encoding to use when parsing and storing data.
"name" string "conf" As with PHPArray, this defines the name of the global configuration root.
"indent" string " " The character used for indentation when writing the XML document, if any. By default, two spaces are used.
"linebreak" string "\n" The line-breaking character(s) to use when writing the XML document.
"addDecl" boolean TRUE Controls whether the XML declaration is added to the start of the XML document.
"useAttr" boolean TRUE Controls whether attributes are parsed and saved.
"isFile" boolean TRUE If TRUE, the first argument to parseConfig() will be taken as the file name for the XML file to load. If FALSE, the argument will be taken as the XML data itself and parsed accordingly.
"useCData" boolean FALSE Controls whether data is enclosed in CDATA blocks.



Editing a configuration Config::Config

Config

PEAR Manual