HTML_QuickForm_Renderer Class Reference

Inheritance diagram for HTML_QuickForm_Renderer:

Public Member Functions
	HTML_QuickForm_Renderer ()
	startForm (&$form)
	finishForm (&$form)
	renderHeader (&$header)
	renderElement (&$element, $required, $error)
	renderHidden (&$element)
	renderHtml (&$data)
	startGroup (&$group, $required, $error)
	finishGroup (&$group)

---

Detailed Description

An abstract base class for QuickForm renderers

The class implements a Visitor design pattern

Author:

Alexey Borzov <borz_off@cs.msu.su>

Definition at line 29 of file Renderer.php.

---

Member Function Documentation

finishForm

(

&$

form

)

Called when visiting a form, after processing all form elements

Parameters:

object

An HTML_QuickForm object being visited public

Returns:

void

Reimplemented in MoodleQuickForm_Renderer, HTML_QuickForm_Renderer_Tableless, and HTML_QuickForm_Renderer_Default.

Definition at line 61 of file Renderer.php.

finishGroup

(

&$

group

)

Called when visiting a group, after processing all group elements

Parameters:

object

An HTML_QuickForm_group object being visited public

Returns:

void

Reimplemented in HTML_QuickForm_Renderer_Default, HTML_QuickForm_Renderer_Array, and HTML_QuickForm_Renderer_Object.

Definition at line 145 of file Renderer.php.

HTML_QuickForm_Renderer

(

)

Constructor

public

Definition at line 36 of file Renderer.php.

Here is the caller graph for this function:

renderElement	(	&$	element,
		$	required,
		$	error
	)

Called when visiting an element

Parameters:

object	An HTML_QuickForm_element object being visited
bool	Whether an element is required
string	An error message associated with an element public

Returns:

void

Reimplemented in MoodleQuickForm_Renderer, HTML_QuickForm_Renderer_Default, HTML_QuickForm_Renderer_Array, HTML_QuickForm_Renderer_Tableless, and HTML_QuickForm_Renderer_Object.

Definition at line 89 of file Renderer.php.

renderHeader

(

&$

header

)

Called when visiting a header element

Parameters:

object

An HTML_QuickForm_header element being visited public

Returns:

void

Reimplemented in MoodleQuickForm_Renderer, HTML_QuickForm_Renderer_Default, HTML_QuickForm_Renderer_Array, HTML_QuickForm_Renderer_Tableless, and HTML_QuickForm_Renderer_Object.

Definition at line 74 of file Renderer.php.

renderHidden

(

&$

element

)

Called when visiting a hidden element

Parameters:

object

An HTML_QuickForm_hidden object being visited public

Returns:

void

Reimplemented in HTML_QuickForm_Renderer_Default, HTML_QuickForm_Renderer_Array, and HTML_QuickForm_Renderer_Object.

Definition at line 102 of file Renderer.php.

renderHtml

(

&$

data

)

Called when visiting a raw HTML/text pseudo-element

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

Parameters:

object

An HTML_QuickForm_html element being visited public

Returns:

void

Reimplemented in HTML_QuickForm_Renderer_Default.

Definition at line 117 of file Renderer.php.

startForm

(

&$

form

)

Called when visiting a form, before processing any form elements

Parameters:

object

An HTML_QuickForm object being visited public

Returns:

void

Reimplemented in MoodleQuickForm_Renderer, HTML_QuickForm_Renderer_Tableless, HTML_QuickForm_Renderer_Array, HTML_QuickForm_Renderer_Default, and HTML_QuickForm_Renderer_Object.

Definition at line 48 of file Renderer.php.

startGroup	(	&$	group,
		$	required,
		$	error
	)

Called when visiting a group, before processing any group elements

Parameters:

object	An HTML_QuickForm_group object being visited
bool	Whether a group is required
string	An error message associated with a group public

Returns:

void

Reimplemented in MoodleQuickForm_Renderer, HTML_QuickForm_Renderer_Default, HTML_QuickForm_Renderer_Array, and HTML_QuickForm_Renderer_Object.

Definition at line 132 of file Renderer.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/pear/HTML/QuickForm/Renderer.php