Config::parseConfig

Config::parseConfig() – Parse datasource contents

Synopsis

require_once 'Config.php';

mixed &Config::parseConfig ( mixed $datasrc , string $configType , array $options = array() )

Description

This method will parse the datasource given and fill the root Config_Container object with other Config_Container objects. It will return a reference to the root Config_Container object or a PEAR_Error if something went wrong.

Parameter

mixed $datasrc

Datasource to parse. For most containers, it is a file path. For the PHP array parser, it can be an array too.

string $configType

Type of configuration to parse

array $options

Options for the parser

Return value

object - a reference to Config_Container object

Throws

Possible PEAR_Error values
Error code Error value Meaning Solution
PEAR_ERROR_RETURN "Configuration type '$configType' is not registered in Config::parseConfig." The config type must be registered for use by Config. Use one of the standard config types, or register your custom container using Config::registerConfigType

Other errors may be returned from the parser for the specific container you're using.

Note

This function can not be called statically.

Example

Using parseConfig()

<?php
$config 
= new Config();
$root =& $config->parseConfig('/path/to/file.php''phparray'
                                array(
'name' => 'conf'));
?>
Returns TRUE if container is registered (Previous) Registers a custom Config container (Next)
Last updated: Sat, 23 Aug 2014 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: vikas1284@gmail.com
$conf = new Config;
$root = $conf->parseConfig($file, 'XML');

memory_get_usage();
$conf = new Config;
$root = $conf->parseConfig($file, 'XML');
memory_get_usage();

these statements will eat too much memory. even unset() won't be able to free some memory. this produces fatal memory errors while parsing large xml files in a repeated loop.
Note by: info@karikas.com
Ahoy, a quick reference - values for the config type can be (as per v 1.21): apache, genericconf, inifile, inicommented, phparray, xml.