Config::parseConfig
Prev		Next

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'));
?>

Prev	Config class	Next
Config::isConfigTypeRegistered	PEAR Manual	Config::registerConfigType