Docs For Class HTML_QuickForm

HTML_QuickForm_Renderer HTML_QuickForm_Renderer(
)

Constructor

Access: public

[ Top ]

void finishForm(
object An
&$form)

Called when visiting a form, after processing all form elements

Abstract:
Access: public

Overridden in child classes as:

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.

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

HTML_QuickForm_Renderer_ITDynamic::finishForm()

Parameters:

object An &$form — HTML_QuickForm object being visited

[ Top ]

void finishGroup(
object An
&$group)

Called when visiting a group, after processing all group elements

Abstract:
Access: public

Overridden in child classes as:

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()

HTML_QuickForm_Renderer_Object::finishGroup()

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

HTML_QuickForm_Renderer_ITDynamic::finishGroup()

HTML_QuickForm_Renderer_Array::finishGroup()

Parameters:

object An &$group — HTML_QuickForm_group object being visited

[ Top ]

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

Called when visiting an element

Abstract:
Access: public

Overridden in child classes as:

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()

HTML_QuickForm_Renderer_Object::renderElement()

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

HTML_QuickForm_Renderer_ITDynamic::renderElement()

HTML_QuickForm_Renderer_Array::renderElement()

Parameters:

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

[ Top ]

void renderHeader(
object An
&$header)

Called when visiting a header element

Abstract:
Access: public

Overridden in child classes as:

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

HTML_QuickForm_Renderer_Object::renderHeader()

HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()

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

HTML_QuickForm_Renderer_ITDynamic::renderHeader()

HTML_QuickForm_Renderer_Array::renderHeader()

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

Parameters:

object An &$header — HTML_QuickForm_header element being visited

[ Top ]

void renderHidden(
object An
&$element)

Called when visiting a hidden element

Abstract:
Access: public

Overridden in child classes as:

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.

HTML_QuickForm_Renderer_Object::renderHidden()

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

HTML_QuickForm_Renderer_ITDynamic::renderHidden()

HTML_QuickForm_Renderer_Array::renderHidden()

Parameters:

object An &$element — HTML_QuickForm_hidden object being visited

[ Top ]

void renderHtml(
object An
&$data)

Called when visiting a raw HTML/text pseudo-element

Seems that this should not be used when using a template-based renderer

Abstract:
Access: public

Overridden in child classes as:

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

Parameters:

object An &$data — HTML_QuickForm_html element being visited

[ Top ]

void startForm(
object An
&$form)

Called when visiting a form, before processing any form elements

Abstract:
Access: public

Overridden in child classes as:

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

HTML_QuickForm_Renderer_Object::startForm()

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

HTML_QuickForm_Renderer_Array::startForm()

Parameters:

object An &$form — HTML_QuickForm object being visited

[ Top ]

void startGroup(
object An
&$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_Default::startGroup(): Called when visiting a group, before processing any group elements

HTML_QuickForm_Renderer_Object::startGroup()

HTML_QuickForm_Renderer_ObjectFlexy::startGroup()

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

HTML_QuickForm_Renderer_ITDynamic::startGroup()

HTML_QuickForm_Renderer_Array::startGroup()

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

Parameters:

object An	`&$group`	—	HTML_QuickForm_group object 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):

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Method Detail

HTML_QuickForm_Renderer (Constructor) [line 36]

finishForm [line 61]

Parameters:

finishGroup [line 145]

Parameters:

renderElement [line 89]

Parameters:

renderHeader [line 74]

Parameters:

renderHidden [line 102]

Parameters:

renderHtml [line 117]

Parameters:

startForm [line 48]

Parameters:

startGroup [line 132]

Parameters: