Class Horde_Config

Description

The Config:: package provides a framework for managing the configuration of Horde applications, writing conf.php files from conf.xml source files, generating user interfaces, etc.

$Horde: framework/Horde/Horde/Config.php,v 1.80.2.40 2009/02/25 05:35:42 chuck Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Horde/Horde/Config.php (line 37)


	
			
Variable Summary
 string $_app
 string $_configBegin
 string $_configEnd
 string $_oldConfig
 string $_phpConfig
 string $_postConfig
 string $_preConfig
 string $_versionTag
Method Summary
 Horde_Config Horde_Config (string $app)
 string generatePHPConfig (Variables $formvars, [array $custom_conf = null])
 string getPHPConfig ()
 array readXMLConfig ([array $custom_conf = null])
Variables
string $_app (line 44)

The name of the configured application.

string $_configBegin = "/* CONFIG START. DO NOT CHANGE ANYTHING IN OR AFTER THIS LINE. */\n" (line 102)

The line marking the begin of the generated configuration.

string $_configEnd = "/* CONFIG END. DO NOT CHANGE ANYTHING IN OR BEFORE THIS LINE. */\n" (line 109)

The line marking the end of the generated configuration.

array $_currentConfig = array() (line 87)

The current $conf array of the configured application.

string $_oldConfig (line 66)

The content of the old configuration file.

string $_phpConfig (line 59)

The content of the generated configuration file.

string $_postConfig (line 80)

The manual configuration after the generated configuration.

string $_preConfig (line 73)

The manual configuration in front of the generated configuration.

string $_versionTag = '' (line 95)

The CVS version tag of the conf.xml file which will be copied into the conf.php file.

array $_xmlConfigTree = null (line 52)

The XML tree of the configuration file traversed to an associative array.

Methods
Constructor Horde_Config (line 116)

Constructor.

Horde_Config Horde_Config (string $app)
  • string $app: The name of the application to be configured.
generatePHPConfig (line 215)

Generates the content of the application's configuration file.

  • return: The content of the generated configuration file.
string generatePHPConfig (Variables $formvars, [array $custom_conf = null])
  • Variables $formvars: The processed configuration form data.
  • array $custom_conf: Any settings that shall be included in the generated configuration.
getPHPConfig (line 179)

Returns the file content of the current configuration file.

  • return: The unparsed configuration file content.
string getPHPConfig ()
readXMLConfig (line 130)

Reads the application's conf.xml file and builds an associative array from its XML tree.

  • return: An associative array representing the configuration tree.
array readXMLConfig ([array $custom_conf = null])
  • array $custom_conf: Any settings that shall be included in the generated configuration.

Documentation generated on Sun, 30 Jan 2011 05:15:58 +0000 by phpDocumentor 1.4.3