|
|
|
File: ../general-devel/lib/support/conf/conf.class.php
phpGeneral - support
Conf
Conf
Base class for config file api
|
private class Conf extends Locale
Base class for config file api
Includes common code of all inherited classes, such as localization support.Futhermore it provides the common access interface for configuration options.
|
| |
|
Direct known subclasses: ConfPhparray
|
|
|
|
|
|
Private Field Summary |
| integer |
$config |
|
|
|
Public Method Details |
getParameter |
|
public boolean getParameter( string $path, string &$param, string &$errmsg )
|
| |
Access interface to configuration options
This member function provides an implementation for all config file classesto access the configuration options. The requested configuration option isstored as string in $path. This string consists of the name of theconfiguration option or a path to the name of this option, e.g."my/requested/option" whereas "requested" is a subarray of "my" and "option"is a member of the "requested" array.
|
| Parameter |
|
| string |
$path |
|
|
Path to the value of the option in the hierarchy |
|
|
| string |
&$param |
|
|
Reference where the value of the option is stored |
|
|
| string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
| Returns |
boolean True on success, false otherwise |
|
|
Private Method Details |
Conf |
|
private object Conf Conf( array $param, string &$errmsg )
|
| |
Class constructor
Initializes localization support for error messages
|
| Parameter |
|
| array |
$param |
|
|
Associative array contains userid, password and realm |
|
|
| string |
&$errmsg |
|
|
Reference for storing error messages in case of a failure |
|
| Returns |
object Conf |
|
|
Private Field Details |
$config |
|
private integer $config
>>
|
|
|
|
|
|
|
|
| PHPDoc 1.0beta |