PEAR Manual
Prev |  | Next

# Config::setRoot()

Config::setRoot() -- Set content of root Config_container object

## Synopsis

    require_once 'Config.php';

``mixed Config::setRoot` (object &$rootContainer)`

## Description

This method will replace the current child of the root Config_Container object by the given object.

## Parameter

object `$rootContainer`

  Container to be used as the first child of root

## Return value

`boolean` - Returns `TRUE` on success, `FALSE` on failure.

## Note

This function can not be called statically.

## Example

Example 31-1. Using setRoot()
    $container =& new Config_Container('section', 'conf');

    $config = new Config();
    $root =& $config->setRoot($container);

Prev | Home | Next
Config::parseConfig() | Up | Config::writeConfig()