Horde_Config_Form
extends Horde_Form
in package
A Horde_Form:: form that implements a user interface for the config system.
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.
Tags
Table of Contents
Properties
- $_fillvars : bool
- Whether to fill $this->_vars with values from the existing configuration.
- $_vars : Horde_Variables
- Contains the Horde_Variables object of this form.
- $_xmlConfig : Horde_Config
- Contains the Horde_Config object that this form represents.
Methods
- __construct() : mixed
- Constructor.
- _buildVariables() : mixed
- Builds the form based on the specified level of the configuration tree.
Properties
$_fillvars
Whether to fill $this->_vars with values from the existing configuration.
protected
bool
$_fillvars
$_vars
Contains the Horde_Variables object of this form.
protected
Horde_Variables
$_vars
$_xmlConfig
Contains the Horde_Config object that this form represents.
protected
Horde_Config
$_xmlConfig
Methods
__construct()
Constructor.
public
__construct(Horde_Variables &$vars, string $app[, bool $fillvars = false ]) : mixed
Parameters
- $vars : Horde_Variables
-
The variables object of this form.
- $app : string
-
The name of the application that this configuration form is for.
- $fillvars : bool = false
-
Whether to fill the $vars object with values from the existing configuration.
_buildVariables()
Builds the form based on the specified level of the configuration tree.
protected
_buildVariables(array<string|int, mixed> $config[, string $prefix = '' ]) : mixed
Parameters
- $config : array<string|int, mixed>
-
The portion of the configuration tree for that the form fields should be created.
- $prefix : string = ''
-
A string representing the current position inside the configuration tree.