Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/lib/pear/HTML/QuickForm/Renderer/ -> Default.php (source)
(no description)
| File Size: | 483 lines (16 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 2 classes
HTML_QuickForm_Renderer_Default:: (2 methods):
__construct()
HTML_QuickForm_Renderer_Default()
name:: (17 methods):
toHtml()
startForm()
finishForm()
renderHeader()
_prepareTemplate()
renderElement()
renderHidden()
renderHtml()
startGroup()
finishGroup()
setElementTemplate()
setGroupTemplate()
setGroupElementTemplate()
setHeaderTemplate()
setFormTemplate()
setRequiredNoteTemplate()
clearAllTemplates()
Class: HTML_QuickForm_Renderer_Default - X-Ref
A concrete renderer for HTML_QuickForm,based on QuickForm 2.x built-in one
| __construct() X-Ref |
| Constructor |
| HTML_QuickForm_Renderer_Default() X-Ref |
| Old syntax of class constructor. Deprecated in PHP7. |
| toHtml() X-Ref |
| returns the HTML generated for the form return: string |
| startForm(&$form) X-Ref |
| Called when visiting a form, before processing any form elements return: void param: object An HTML_QuickForm object being visited |
| finishForm(&$form) X-Ref |
| Called when visiting a form, after processing all form elements Adds required note, form attributes, validation javascript and form content. return: void param: object An HTML_QuickForm object being visited |
| renderHeader(&$header) X-Ref |
| Called when visiting a header element return: void param: object An HTML_QuickForm_header element being visited |
| _prepareTemplate($name, $label, $required, $error) X-Ref |
| Helper method for renderElement return: string Html for element param: string Element name param: mixed Element label (if using an array of labels, you should set the appropriate template) param: bool Whether an element is required param: string Error message associated with the element |
| renderElement(&$element, $required, $error) X-Ref |
| Renders an element Html Called when visiting an element return: void param: object An HTML_QuickForm_element object being visited param: bool Whether an element is required param: string An error message associated with an element |
| renderHidden(&$element) X-Ref |
| Renders an hidden element Called when visiting a hidden element return: void param: object An HTML_QuickForm_hidden object being visited |
| renderHtml(&$data) X-Ref |
| Called when visiting a raw HTML/text pseudo-element return: void param: object An HTML_QuickForm_html element being visited |
| startGroup(&$group, $required, $error) X-Ref |
| Called when visiting a group, before processing any group elements return: void param: object An HTML_QuickForm_group object being visited param: bool Whether a group is required param: string An error message associated with a group |
| finishGroup(&$group) X-Ref |
| Called when visiting a group, after processing all group elements return: void param: object An HTML_QuickForm_group object being visited |
| setElementTemplate($html, $element = null) X-Ref |
| Sets element template return: void param: string The HTML surrounding an element param: string (optional) Name of the element to apply template for |
| setGroupTemplate($html, $group) X-Ref |
| Sets template for a group wrapper This template is contained within a group-as-element template set via setTemplate() and contains group's element templates, set via setGroupElementTemplate() return: void param: string The HTML surrounding group elements param: string Name of the group to apply template for |
| setGroupElementTemplate($html, $group) X-Ref |
| Sets element template for elements within a group return: void param: string The HTML surrounding an element param: string Name of the group to apply template for |
| setHeaderTemplate($html) X-Ref |
| Sets header template return: void param: string The HTML surrounding the header |
| setFormTemplate($html) X-Ref |
| Sets form template return: void param: string The HTML surrounding the form tags |
| setRequiredNoteTemplate($html) X-Ref |
| Sets the note indicating required fields template return: void param: string The HTML surrounding the required note |
| clearAllTemplates() X-Ref |
| Clears all the HTML out of the templates that surround notes, elements, etc. Useful when you want to use addData() to create a completely custom form look return: void |
