$_app
$_app : string
The name of the configured application.
The Horde_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.
Copyright 2002-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
readXMLConfig(array $custom_conf = null) : array
Reads the application's conf.xml file and builds an associative array from its XML tree.
array | $custom_conf | Any settings that shall be included in the generated configuration. |
An associative array representing the configuration tree.
writePHPConfig(\Horde_Variables $formvars, string $php = null) : boolean
Generates and writes the content of the application's configuration file.
\Horde_Variables | $formvars | The processed configuration form data. |
string | $php | The content of the generated configuration file. |
True if the configuration file could be written immediately to the file system.
generatePHPConfig(\Horde_Variables $formvars, array $custom_conf = null) : string
Generates the content of the application's configuration file.
\Horde_Variables | $formvars | The processed configuration form data. |
array | $custom_conf | Any settings that shall be included in the generated configuration. |
The content of the generated configuration file.
configNoSQL(string $ctx, \DomNode $node = null, string $switchname = 'driverconfig') : array
Returns the configuration tree for a NoSQL backend configuration to replace a <confignosql> tag.
Subnodes will be parsed and added to both the Horde defaults and the custom configuration parts.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
string | $switchname | If DomNode is not set, the value of the tag's switchname attribute. |
An associative array with the SQL configuration tree.
configSQL(string $ctx, \DomNode $node = null, string $switchname = 'driverconfig') : array
Returns the configuration tree for an SQL backend configuration to replace a <configsql> tag.
Subnodes will be parsed and added to both the Horde defaults and the Custom configuration parts.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
string | $switchname | If DomNode is not set, the value of the tag's switchname attribute. |
An associative array with the SQL configuration tree.
_generatePHPConfig(array $section, string $prefix, \Horde_Variables $formvars)
Generates the configuration file items for a part of the configuration tree.
array | $section | An associative array containing the part of the traversed XML configuration tree that should be processed. |
string | $prefix | A configuration prefix determining the current position inside the configuration file. This prefix will be translated to keys of the $conf array in the generated configuration file. |
\Horde_Variables | $formvars | The processed configuration form data. |
_parseLevel( $conf, \DOMNodeList $children, string $ctx)
Parses one level of the configuration XML tree into the associative array containing the traversed configuration tree.
$conf | ||
\DOMNodeList | $children | The XML nodes of the level that should be parsed. |
string | $ctx | A string representing the current position (context prefix) inside the configuration XML file. |
_configLDAP(string $ctx, \DomNode $node = null, string $switchname = 'driverconfig') : array
Returns the configuration tree for an LDAP backend configuration to replace a <configldap> tag.
Subnodes will be parsed and added to both the Horde defaults and the Custom configuration parts.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
string | $switchname | If $node is not set, the value of the tag's switchname attribute. |
An associative array with the LDAP configuration tree.
_configLDAPUser(string $ctx, \DomNode $node = null) : array
Returns the configuration tree for an LDAP configuration to search user DNs to replace a <configldapuser> tag.
Subnodes will be parsed and added.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
A list of associative arrays with the LDAP configuration tree.
_configSQLSplitRead(string $ctx, \DomNode $node, string $phptype) : array
Returns the configuration items for split-read database setups.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
string | $phptype | The SQL backend name. |
An associative array with the split-read SQL configuration tree.
_configVFS(string $ctx, \DomNode $node) : array
Returns the configuration tree for a VFS backend configuration to replace a <configvfs> tag.
Subnodes will be parsed and added to both the Horde defaults and the Custom configuration parts.
string | $ctx | The context of the |
\DomNode | $node | The DomNode representation of the |
An associative array with the VFS configuration tree.
_default(string $ctx, mixed $default) : mixed
Returns a certain value from the current configuration array or a default value, if not found.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
Either the value of the configuration array's requested key or the default value if the key wasn't found.
_isDefault(string $ctx, mixed $default) : boolean
Returns whether a certain value from the current configuration array exists or a default value will be used.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
Whether the default value will be used.
__default(string $ctx, mixed $default) : array
Returns a certain value from the current configuration array or a default value, if not found, and which of the values have been returned.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
First element: either the value of the configuration array's requested key or the default value if the key wasn't found. Second element: whether the returned value was the default value.
_defaultRaw(string $ctx, mixed $default) : mixed
Returns a certain value from the current configuration file or a default value, if not found.
It does NOT return the actual value, but the PHP expression as used in the configuration file.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
Either the value of the configuration file's requested key or the default value if the key wasn't found.
_isDefaultRaw(string $ctx, mixed $default) : boolean
Returns whether a certain value from the current configuration array exists or a default value will be used.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
Whether the default value will be used.
__defaultRaw(string $ctx, mixed $default) : array
Returns a certain value from the current configuration file or a default value, if not found, and which of the values have been returned.
It does NOT return the actual value, but the PHP expression as used in the configuration file.
string | $ctx | A string representing the key of the configuration array to return. |
mixed | $default | The default value to return if the key wasn't found. |
First element: either the value of the configuration array's requested key or the default value if the key wasn't found. Second element: whether the returned value was the default value.
_getEnumValues(\DomNode $node) : array
Returns an associative array containing all possible values of the specified <configenum> tag.
The keys contain the actual enum values while the values contain their corresponding descriptions.
\DomNode | $node | The DomNode representation of the |
An associative array with all possible enum values.
_handleSpecials(\DomNode $node) : array
Returns an associative array containing the possible values of a <configspecial> tag as used inside of enum configurations.
\DomNode | $node | The DomNode representation of the |
An associative array with the possible values.