Horde_Core_Ui_VarRenderer
in package
The Horde_Core_Ui_VarRenderer:: class provides base functionality for other Horde UI elements.
Tags
Table of Contents
Properties
- $_params : array<string|int, mixed>
- Parameters which change this renderer's behavior.
Methods
- __construct() : mixed
- Constructs a new renderer.
- factory() : Horde_Core_Ui_VarRenderer
- Constructs a new instance.
- render() : mixed
- Renders a variable.
- renderEnd() : string
- Finishes rendering after all fields are output.
Properties
$_params
Parameters which change this renderer's behavior.
protected
array<string|int, mixed>
$_params
Methods
__construct()
Constructs a new renderer.
public
__construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
- $params : array<string|int, mixed> = array()
-
The name of the variable which will track this UI widget's state.
factory()
Constructs a new instance.
public
static factory(mixed $driver[, array<string|int, mixed> $params = array() ]) : Horde_Core_Ui_VarRenderer
Parameters
- $driver : mixed
-
This is the renderer subclass we will instantiate. If an array is passed, the first element is the library path and the second element is the driver name.
- $params : array<string|int, mixed> = array()
-
Parameters specific to the subclass.
Tags
Return values
Horde_Core_Ui_VarRenderer —A subclass instance.
render()
Renders a variable.
public
render(Horde_Form $form, Horde_Form_Variable $var, Variables $vars[, bool $isInput = false ]) : mixed
Parameters
- $form : Horde_Form
-
A Horde_Form instance, or null if none is available.
- $var : Horde_Form_Variable
-
A Horde_Form_Variable.
- $vars : Variables
-
A Horde_Variables instance.
- $isInput : bool = false
-
Whether this is an input field.
renderEnd()
Finishes rendering after all fields are output.
public
renderEnd() : string
Return values
string —TODO