Docs For Class HTML_QuickForm_Renderer

$_duplicateElements = array()

[line 76]

If elements have been added with the same name

Type:

array

[ Top ]

$_elementIndex = 0

[line 70]

Index of the element in its group

Type:

int

[ Top ]

$_error = '{error} {html}'

[line 88]

How to handle error messages in form validation

Type:

string

[ Top ]

$_errors = array()

[line 52]

The errors that were not shown near concrete fields go here

Type:

array

[ Top ]

$_formName = 'form'

[line 46]

Rendered form name

Type:

string

[ Top ]

$_hidden = ''

[line 94]

Collected HTML for hidden elements, if needed

Type:

string

[ Top ]

$_inGroup =

[line 64]

Which group are we currently parsing ?

Type:

string

[ Top ]

$_required = '{label}*'

[line 82]

How to handle the required tag for required fields

Type:

string

[ Top ]

$_showRequired = false

[line 58]

Show the block with required note?

Type:

bool

[ Top ]

$_tpl = null

[line 40]

An HTML_Template_IT or some other API compatible Template instance

Type:

object

[ Top ]

constructor HTML_QuickForm_Renderer_ITStatic [line 101]

HTML_QuickForm_Renderer_ITStatic HTML_QuickForm_Renderer_ITStatic(
object An
&$tpl)

Constructor

Parameters:

object An

&$tpl

HTML_Template_IT or other compatible Template object to use

[ Top ]

method finishForm [line 133]

void finishForm(
object An
&$form)

Called when visiting a form, after processing all form elements

Tags:

access:

public

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

Parameters:

object An

&$form

HTML_QuickForm object being visited

[ Top ]

method finishGroup [line 329]

void finishGroup(
object An
&$group)

Called when visiting a group, after processing all group elements

Tags:

access:

public

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

Parameters:

object An

&$group

HTML_QuickForm_group object being visited

[ Top ]

method renderElement [line 184]

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

Called when visiting an element

Tags:

access:

public

Overrides HTML_QuickForm_Renderer::renderElement() (Called when visiting an element)

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 ]

method renderHeader [line 163]

void renderHeader(
object An
&$header)

Called when visiting a header element

Tags:

access:

public

Overrides HTML_QuickForm_Renderer::renderHeader() (Called when visiting a header element)

Parameters:

object An

&$header

HTML_QuickForm_header element being visited

[ Top ]

method renderHidden [line 258]

void renderHidden(
object An
&$element)

Called when visiting a hidden element

Tags:

access:

public

Overrides HTML_QuickForm_Renderer::renderHidden() (Called when visiting a hidden element)

Parameters:

object An

&$element

HTML_QuickForm_hidden object being visited

[ Top ]

method setErrorTemplate [line 376]

void setErrorTemplate(
string
$template)

Sets the way elements with validation errors are rendered

You can use {label} or {html} placeholders to let the renderer know where where the element label or the element html are positionned according to the error message. They will be replaced accordingly with the right value. The error message will replace the {error} place holder. For example: {error}
{html} will put the error message in red on top of the element html.

If you want all error messages to be output in the main error block, do not specify {html} nor {label}.

Groups can have special layouts. With this kind of groups, the renderer will need to know where to place the error message. In this case, use error blocks like: {form_group_error} where you want the error message to appear in the form.

Tags:

access:

public

Parameters:

string

$template

The element error template

[ Top ]

method setRequiredTemplate [line 348]

void setRequiredTemplate(
string
$template)

Sets the way required elements are rendered

You can use {label} or {html} placeholders to let the renderer know where where the element label or the element html are positionned according to the required tag. They will be replaced accordingly with the right value. For example: *{label} will put a red star in front of the label if the element is required.

Tags:

access:

public

Parameters:

string

$template

The required element template

[ Top ]

method startForm [line 114]

void startForm(
object An
&$form)

Called when visiting a form, before processing any form elements

Tags:

access:

public

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

Parameters:

object An

&$form

HTML_QuickForm object being visited

[ Top ]

method startGroup [line 278]

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

Called when visiting a group, before processing any group elements

Tags:

access:

public

Overrides HTML_QuickForm_Renderer::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 ]

method _getTplBlock [line 476]

string _getTplBlock(
string
$block)

Returns the block's contents

The method is needed because ITX and Sigma implement clearing the block contents on get() a bit differently

Tags:

return:

Block contents

Parameters:

string

$block

Block name

[ Top ]

method _renderError [line 436]

void _renderError(
string
&$label, string
&$html, string
$error)

Called when an element has a validation error

This method will add the error message to the element label or the element html such as defined with the method setErrorTemplate. If the error placeholder is not found in the template, the error will be displayed in the form error block.

Tags:

see:	HTML_QuickForm_Renderer_ITStatic::setErrorTemplate()
access:	private

Parameters:

string	&$label	The element label
string	&$html	The element html rendering
string	$error	The element error

[ Top ]

method _renderRequired [line 393]

void _renderRequired(
string
&$label, string
&$html)

Called when an element is required

This method will add the required tag to the element label and/or the element html such as defined with the method setRequiredTemplate

Tags:

see:	HTML_QuickForm_Renderer_ITStatic::setRequiredTemplate()
access:	private

Parameters:

string	&$label	The element label
string	&$html	The element html rendering

[ Top ]

Class: HTML_QuickForm_Renderer_ITStatic

Class Overview

Author(s):

Variables

Methods

Inherited Methods

Class: HTML_QuickForm_Renderer

Class Details

Tags:

Class Variables

$_duplicateElements = array()

$_elementIndex = 0

$_error = '<font color="red">{error}</font><br />{html}'

$_errors = array()

$_formName = 'form'

$_hidden = ''

$_inGroup =

$_required = '{label}<font size="1" color="red">*</font>'

$_showRequired = false

$_tpl = null

Class Methods

constructor HTML_QuickForm_Renderer_ITStatic [line 101]

Parameters:

method finishForm [line 133]

Tags:

Parameters:

method finishGroup [line 329]

Tags:

Parameters:

method renderElement [line 184]

Tags:

Parameters:

method renderHeader [line 163]

Tags:

Parameters:

method renderHidden [line 258]

Tags:

Parameters:

method setErrorTemplate [line 376]

Tags:

Parameters:

method setRequiredTemplate [line 348]

Tags:

Parameters:

method startForm [line 114]

Tags:

Parameters:

method startGroup [line 278]

Tags:

Parameters:

method _getTplBlock [line 476]

Tags:

Parameters:

method _renderError [line 436]

Tags:

Parameters:

method _renderRequired [line 393]

Tags:

Parameters: