Class: HTML_QuickForm2_Renderer_Array
Source Location: /HTML_QuickForm2-2.1.0/HTML/QuickForm2/Renderer/Array.php
HTML_QuickForm2_Renderer
|
--HTML_QuickForm2_Renderer_Array
A renderer for HTML_QuickForm2 building an array of form elements
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
[line 110]
A renderer for HTML_QuickForm2 building an array of form elements Based on Array renderer from HTML_QuickForm 3.x package The form array structure is the following: array(
'id' => form's "id" attribute (string),
'frozen' => whether the form is frozen (bool),
'attributes' => attributes for <form> tag (string),
// if form contains required elements:
'required_note' => note about the required elements (string),
// if 'group_hiddens' option is true:
'hidden' => array with html of hidden elements (array),
// if form has some javascript for setup or validation:
'javascript' => form javascript (string)
// if 'group_errors' option is true:
'errors' => array(
'1st element id' => 'Error for the 1st element',
...
'nth element id' => 'Error for the nth element'
),
'elements' => array(
element_1,
...
element_N
)
); Where element_i is an array of the form array(
'id' => element id (string),
'type' => type of the element (string),
'frozen' => whether element is frozen (bool),
// if element has a label:
'label' => 'label for the element',
// note that if 'static_labels' option is true and element's label is an
// array then there will be several 'label_*' keys corresponding to
// labels' array keys
'required' => whether element is required (bool),
// if a validation error is present and 'group_errors' option is false:
'error' => error associated with the element (string),
// if some style was associated with an element:
'style' => 'some information about element style (e.g. for Smarty)',
// if element is not a Container
'value' => element value (mixed),
'html' => HTML for the element (string),
// if element is a Container
'attributes' => container attributes (string)
// if element is a Group
'class' => element's 'class' attribute
// only for groups, if separator is set:
'separator' => separator for group elements (array),
'elements' => array(
element_1,
...
element_N
)
); While almost everything in this class is defined as public, its properties and those methods that are not published (i.e. not in array returned by exportMethods()) will be available to renderer plugins only. The following methods are published:
Class Variables
Method Detail
Documentation generated on Wed, 10 Apr 2019 08:56:07 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|