Docs For Class HTML_QuickForm

HTML_QuickForm_Renderer HTML_QuickForm_Renderer(
)

Constructor

Access: public

[ Top ]

void finishForm(
HTML_QuickForm
&$form)

Called when visiting a form, after processing all form elements

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_ITDynamic::finishForm()

HTML_QuickForm_Renderer_ITStatic::finishForm(): Called when visiting a form, after processing all form elements

HTML_QuickForm_Renderer_Default::finishForm(): Called when visiting a form, after processing all form elements Adds required note, form attributes, validation javascript and form content.

Parameters:

HTML_QuickForm &$form — a form being visited

[ Top ]

void finishGroup(
HTML_QuickForm_group
&$group)

Called when visiting a group, after processing all group elements

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::finishGroup()

HTML_QuickForm_Renderer_Object::finishGroup()

HTML_QuickForm_Renderer_ITDynamic::finishGroup()

HTML_QuickForm_Renderer_ITStatic::finishGroup(): Called when visiting a group, after processing all group elements

HTML_QuickForm_Renderer_Default::finishGroup(): Called when visiting a group, after processing all group elements

HTML_QuickForm_Renderer_QuickHtml::finishGroup(): Gets the html for the group element and adds it to the array by calling parent::finishGroup()

Parameters:

HTML_QuickForm_group &$group — A group being visited

[ Top ]

void renderElement(
HTML_QuickForm_element
&$element, bool
$required, string
$error)

Called when visiting an element

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderElement()

HTML_QuickForm_Renderer_Object::renderElement()

HTML_QuickForm_Renderer_ITDynamic::renderElement()

HTML_QuickForm_Renderer_ITStatic::renderElement(): Called when visiting an element

HTML_QuickForm_Renderer_Default::renderElement(): Renders an element Html Called when visiting an element

HTML_QuickForm_Renderer_QuickHtml::renderElement(): Gets the html for an element and adds it to the array by calling parent::renderElement()

Parameters:

HTML_QuickForm_element	`&$element`	—	form element being visited
bool	`$required`	—	Whether an element is required
string	`$error`	—	An error message associated with an element

[ Top ]

void renderHeader(
HTML_QuickForm_header
&$header)

Called when visiting a header element

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderHeader()

HTML_QuickForm_Renderer_ArraySmarty::renderHeader(): Called when visiting a header element

HTML_QuickForm_Renderer_Object::renderHeader()

HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()

HTML_QuickForm_Renderer_ITDynamic::renderHeader()

HTML_QuickForm_Renderer_ITStatic::renderHeader(): Called when visiting a header element

HTML_QuickForm_Renderer_Default::renderHeader(): Called when visiting a header element

Parameters:

HTML_QuickForm_header &$header — a header element being visited

[ Top ]

void renderHidden(
HTML_QuickForm_element
&$element)

Called when visiting a hidden element

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderHidden()

HTML_QuickForm_Renderer_Object::renderHidden()

HTML_QuickForm_Renderer_ITDynamic::renderHidden()

HTML_QuickForm_Renderer_ITStatic::renderHidden(): Called when visiting a hidden element

HTML_QuickForm_Renderer_Default::renderHidden(): Renders an hidden element Called when visiting a hidden element

HTML_QuickForm_Renderer_QuickHtml::renderHidden(): Gets the html for a hidden element and adds it to the array.

Parameters:

HTML_QuickForm_element &$element — a hidden element being visited

[ Top ]

void renderHtml(
HTML_QuickForm_html
&$data)

Called when visiting a raw HTML/text pseudo-element

Only implemented in Default renderer. Usage of 'html' elements is discouraged, templates should be used instead.

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Default::renderHtml(): Called when visiting a raw HTML/text pseudo-element

Parameters:

HTML_QuickForm_html &$data — a 'raw html' element being visited

[ Top ]

void startForm(
HTML_QuickForm
&$form)

Called when visiting a form, before processing any form elements

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::startForm()

HTML_QuickForm_Renderer_Object::startForm()

HTML_QuickForm_Renderer_ITStatic::startForm(): Called when visiting a form, before processing any form elements

HTML_QuickForm_Renderer_Default::startForm(): Called when visiting a form, before processing any form elements

Parameters:

HTML_QuickForm &$form — a form being visited

[ Top ]

void startGroup(
HTML_QuickForm_group
&$group, bool
$required, string
$error)

Called when visiting a group, before processing any group elements

Abstract:
Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::startGroup()

HTML_QuickForm_Renderer_ArraySmarty::startGroup(): Called when visiting a group, before processing any group elements

HTML_QuickForm_Renderer_Object::startGroup()

HTML_QuickForm_Renderer_ObjectFlexy::startGroup()

HTML_QuickForm_Renderer_ITDynamic::startGroup()

HTML_QuickForm_Renderer_ITStatic::startGroup(): Called when visiting a group, before processing any group elements

HTML_QuickForm_Renderer_Default::startGroup(): Called when visiting a group, before processing any group elements

Parameters:

HTML_QuickForm_group	`&$group`	—	A group being visited
bool	`$required`	—	Whether a group is required
string	`$error`	—	An error message associated with a group

[ Top ]

Class: HTML_QuickForm_Renderer

Class Overview

Author(s):

Version:

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

HTML_QuickForm_Renderer (Constructor) [line 43]

finishForm [line 68]

Parameters:

finishGroup [line 153]

Parameters:

renderElement [line 96]

Parameters:

renderHeader [line 81]

Parameters:

renderHidden [line 109]

Parameters:

renderHtml [line 125]

Parameters:

startForm [line 55]

Parameters:

startGroup [line 140]

Parameters: