Class: HTML_QuickForm_Renderer_Array

Source Location: /pear/HTML/QuickForm/Renderer/Array.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_Array

A concrete renderer for HTML_QuickForm, makes an array of form contents

Author(s):

Alexey Borzov <borz_off@cs.msu.su>

Child classes:

HTML_QuickForm_Renderer_ArraySmarty: A static renderer for HTML_QuickForm, makes an array of form content useful for an Smarty template

Inherited Methods

Class: HTML_QuickForm_Renderer

HTML_QuickForm_Renderer::HTML_QuickForm_Renderer(): Constructor
HTML_QuickForm_Renderer::finishForm(): Called when visiting a form, after processing all form elements
HTML_QuickForm_Renderer::finishGroup(): Called when visiting a group, after processing all group elements
HTML_QuickForm_Renderer::renderElement(): Called when visiting an element
HTML_QuickForm_Renderer::renderHeader(): Called when visiting a header element
HTML_QuickForm_Renderer::renderHidden(): Called when visiting a hidden element
HTML_QuickForm_Renderer::renderHtml(): Called when visiting a raw HTML/text pseudo-element
HTML_QuickForm_Renderer::startForm(): Called when visiting a form, before processing any form elements
HTML_QuickForm_Renderer::startGroup(): Called when visiting a group, before processing any group elements

Class Details

[line 98]
A concrete renderer for HTML_QuickForm, makes an array of form contents

Based on old toArray() code.

The form array structure is the following: array( 'frozen' => 'whether the form is frozen', 'javascript' => 'javascript for client-side validation', 'attributes' => 'attributes for <form> tag', 'requirednote => 'note about the required elements', // if we set the option to collect hidden elements 'hidden' => 'collected html of all hidden elements', // if there were some validation errors: 'errors' => array( '1st element name' => 'Error for the 1st element', ... 'nth element name' => 'Error for the nth element' ), // if there are no headers in the form: 'elements' => array( element_1, ... element_N ) // if there are headers in the form: 'sections' => array( array( 'header' => 'Header text for the first header', 'name' => 'Header name for the first header', 'elements' => array( element_1, ... element_K1 ) ), ... array( 'header' => 'Header text for the Mth header', 'name' => 'Header name for the Mth header', 'elements' => array( element_1, ... element_KM ) ) ) );

where element_i is an array of the form: array( 'name' => 'element name', 'value' => 'element value', 'type' => 'type of the element', 'frozen' => 'whether element is frozen', 'label' => 'label for the element', 'required' => 'whether element is required', 'error' => 'error associated with the element', 'style' => 'some information about element style (e.g. for Smarty)', // if element is not a group 'html' => 'HTML for the element' // if element is a group 'separator' => 'separator for group elements', 'elements' => array( element_1, ... element_N ) );

Tags:

author:	Alexey Borzov <borz_off@cs.msu.su>
access:	public

[ Top ]

Class Variables

$staticLabels = false

[line 141]

true: render an array of labels to many labels, $key 0 named 'label', the rest "label_$key"

false: leave labels as defined

Type:

bool

[ Top ]

$_ary =

[line 104]

An array being generated

Type:

array

[ Top ]

$_collectHidden = false

[line 134]

true: collect all hidden elements into string; false: process them as usual form elements

Type:

bool

[ Top ]

$_currentGroup = null

[line 122]

Array representing current group

Type:

array

[ Top ]

$_currentSection =

[line 116]

Current section number

Type:

integer

[ Top ]

$_elementStyles = array()

[line 128]

Additional style information for different elements

Type:

array

[ Top ]

$_sectionCount =

[line 110]

Number of sections in the form (i.e. number of headers in it)

Type:

integer

[ Top ]

Class Methods

constructor HTML_QuickForm_Renderer_Array [line 150]

HTML_QuickForm_Renderer_Array HTML_QuickForm_Renderer_Array(
[bool
$collectHidden = false], [bool
$staticLabels = false])

Constructor

Tags:

access:

public

Parameters:

bool	$collectHidden	true: collect all hidden elements into string; false: process them as usual form elements
bool	$staticLabels	true: render an array of labels to many labels, $key 0 to 'label' and the oterh to "label_$key"

[ Top ]

method finishGroup [line 227]

void finishGroup(

&$group)

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

Parameters:

&$group

[ Top ]

method renderElement [line 198]

void renderElement(

&$element, 
$required, 
$error)

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

Parameters:

	&$element
	$required
	$error

[ Top ]

method renderHeader [line 188]

void renderHeader(

&$header)

Overridden in child classes as:

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

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

Parameters:

&$header

[ Top ]

method renderHidden [line 208]

void renderHidden(

&$element)

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

Parameters:

&$element

[ Top ]

method setElementStyle [line 310]

void setElementStyle(
mixed
$elementName, [string
$styleName = null])

Sets a style to use for element rendering

Tags:

access:

public

Parameters:

mixed	$elementName	element name or array ('element name' => 'style name')
string	$styleName	style name if $elementName is not an array

[ Top ]

method startForm [line 170]

void startForm(

&$form)

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

Parameters:

&$form

[ Top ]

method startGroup [line 218]

void startGroup(

&$group, 
$required, 
$error)

Overridden in child classes as:

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

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

Parameters:

	&$group
	$required
	$error

[ Top ]

method toArray [line 164]

array toArray(
)

Returns the resultant array

Tags:

access:

public

[ Top ]

Documentation generated on Sun, 08 Jan 2012 17:51:40 +0100 by phpDocumentor 1.4.3