Config::registerConfigType

Config::registerConfigType() – Registers a custom Config container

Synopsis

require_once 'Config.php';

bool Config::registerConfigType ( string $configType , array $configInfo = false )

Description

This method registers a new container type with the Config class.

Parameter

string $configType

The name of the configuration type.

array $configInfo

An array defining the file containing the container's class definition and the class name. The format for this array is as follows:

<?php
$configInfo 
= array('path/to/Name.php',             // The path to the source file for the class.
                    
'Config_Container_Class_Name'   // The name of the container class.
                   
);
?>

If omitted, the default values are:

<?php
$configInfo 
= array("Config/Container/$configType.php",
                    
"Config_Container_$configType"
                   
);
?>

Return value

mixed - Returns TRUE on success, PEAR_Error on failure.

Parse datasource contents (Previous) Set content of root Config_container object (Next)
Last updated: Sat, 16 Feb 2019 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report.
View this page in:
  • English

User Notes:

There are no user contributed notes for this page.