|
Moodle
2.2.1
http://www.collinsharper.com
|
|
Moodle
2.2.1
http://www.collinsharper.com
|
Public Member Functions | |
| HTML_QuickForm_Renderer_Array ($collectHidden=false, $staticLabels=false) | |
| toArray () | |
| startForm (&$form) | |
| renderHeader (&$header) | |
| renderElement (&$element, $required, $error) | |
| renderHidden (&$element) | |
| startGroup (&$group, $required, $error) | |
| finishGroup (&$group) | |
| _elementToArray (&$element, $required, $error) | |
| _storeArray ($elAry) | |
| setElementStyle ($elementName, $styleName=null) | |
Data Fields | |
| $_ary | |
| $_sectionCount | |
| $_currentSection | |
| $_currentGroup = null | |
| $_elementStyles = array() | |
| $_collectHidden = false | |
| $staticLabels = false | |
A concrete renderer for HTML_QuickForm, makes an array of form contents
Based on old toArray() code.
The form array structure is the following: array( 'frozen' => 'whether the form is frozen', 'javascript' => 'javascript for client-side validation', 'attributes' => 'attributes for <form> tag', 'requirednote => 'note about the required elements', // if we set the option to collect hidden elements 'hidden' => 'collected html of all hidden elements', // if there were some validation errors: 'errors' => array( '1st element name' => 'Error for the 1st element', ... 'nth element name' => 'Error for the nth element' ), // if there are no headers in the form: 'elements' => array( element_1, ... element_N ) // if there are headers in the form: 'sections' => array( array( 'header' => 'Header text for the first header', 'name' => 'Header name for the first header', 'elements' => array( element_1, ... element_K1 ) ), ... array( 'header' => 'Header text for the Mth header', 'name' => 'Header name for the Mth header', 'elements' => array( element_1, ... element_KM ) ) ) );
where element_i is an array of the form: array( 'name' => 'element name', 'value' => 'element value', 'type' => 'type of the element', 'frozen' => 'whether element is frozen', 'label' => 'label for the element', 'required' => 'whether element is required', 'error' => 'error associated with the element', 'style' => 'some information about element style (e.g. for Smarty)', // if element is not a group 'html' => 'HTML for the element' // if element is a group 'separator' => 'separator for group elements', 'elements' => array( element_1, ... element_N ) );
public
| _elementToArray | ( | &$ | element, |
| $ | required, | ||
| $ | error | ||
| ) |
Creates an array representing an element
private
| object | An HTML_QuickForm_element object |
| bool | Whether an element is required |
| string | Error associated with the element |
Definition at line 243 of file Array.php.
| _storeArray | ( | $ | elAry | ) |
| finishGroup | ( | &$ | group | ) |
Called when visiting a group, after processing all group elements
| object | An HTML_QuickForm_group object being visited public |
Reimplemented from HTML_QuickForm_Renderer.
Definition at line 227 of file Array.php.
| HTML_QuickForm_Renderer_Array | ( | $ | collectHidden = false, |
| $ | staticLabels = false |
||
| ) |
Constructor
| bool | true: collect all hidden elements into string; false: process them as usual form elements |
| bool | true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key" public |
Definition at line 150 of file Array.php.
| renderElement | ( | &$ | element, |
| $ | required, | ||
| $ | error | ||
| ) |
Called when visiting an element
| object | An HTML_QuickForm_element object being visited |
| bool | Whether an element is required |
| string | An error message associated with an element public |
Reimplemented from HTML_QuickForm_Renderer.
Definition at line 198 of file Array.php.
| renderHeader | ( | &$ | header | ) |
Called when visiting a header element
| object | An HTML_QuickForm_header element being visited public |
Reimplemented from HTML_QuickForm_Renderer.
| renderHidden | ( | &$ | element | ) |
Called when visiting a hidden element
| object | An HTML_QuickForm_hidden object being visited public |
Reimplemented from HTML_QuickForm_Renderer.
Definition at line 208 of file Array.php.
| setElementStyle | ( | $ | elementName, |
| $ | styleName = null |
||
| ) |
| startForm | ( | &$ | form | ) |
Called when visiting a form, before processing any form elements
| object | An HTML_QuickForm object being visited public |
Reimplemented from HTML_QuickForm_Renderer.
| startGroup | ( | &$ | group, |
| $ | required, | ||
| $ | error | ||
| ) |
Called when visiting a group, before processing any group elements
| object | An HTML_QuickForm_group object being visited |
| bool | Whether a group is required |
| string | An error message associated with a group public |
Reimplemented from HTML_QuickForm_Renderer.
Definition at line 218 of file Array.php.
| toArray | ( | ) |
1.7.6.1 
