Class: HTML_QuickForm_Renderer_Object

Source Location: /HTML_QuickForm-3.2.13/QuickForm/Renderer/Object.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_Object

A concrete renderer for HTML_QuickForm, makes an object from form contents

Author(s):

Ron McClain <ron at humaniq.com>

Version:

Release: 3.2.13

Methods

Child classes:

HTML_QuickForm_Renderer_ObjectFlexy: QuickForm renderer for Flexy template engine, static version.

Inherited Variables

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 40]
A concrete renderer for HTML_QuickForm, makes an object from form contents

Based on HTML_Quickform_Renderer_Array code

Author: Ron McClain <ron@humaniq.com>
Version: Release: 3.2.13
Since: 3.1.1

[ Top ]

Method Detail

HTML_QuickForm_Renderer_Object (Constructor) [line 95]

HTML_QuickForm_Renderer_Object HTML_QuickForm_Renderer_Object(
[bool
$collecthidden = false])

Constructor

Access: public

Parameters:

bool $collecthidden — true: collect all hidden elements

[ Top ]

finishGroup [line 173]

void finishGroup(

&$group)

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

Parameters:

&$group —

[ Top ]

renderElement [line 145]

void renderElement(

&$element, 
$required, 
$error)

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

Parameters:

	`&$element`	—
	`$required`	—
	`$error`	—

[ Top ]

renderHeader [line 137]

void renderHeader(

&$header)

Overridden in child classes as:

HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()

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

Parameters:

&$header —

[ Top ]

renderHidden [line 155]

void renderHidden(

&$element)

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

Parameters:

&$element —

[ Top ]

setElementStyle [line 242]

void setElementStyle(

$elementName, [
$styleName = null])

Parameters:

	`$elementName`	—
	`$styleName`	—

[ Top ]

setElementType [line 116]

void setElementType(
string
$type)

Set the class of the form elements. Defaults to QuickformElement.

Access: public

Parameters:

string $type — Name of element class

[ Top ]

startForm [line 121]

void startForm(

&$form)

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

Parameters:

&$form —

[ Top ]

startGroup [line 164]

void startGroup(

&$group, 
$required, 
$error)

Overridden in child classes as:

HTML_QuickForm_Renderer_ObjectFlexy::startGroup()

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

Parameters:

	`&$group`	—
	`$required`	—
	`$error`	—

[ Top ]

toObject [line 106]

void toObject(
)

Return the rendered Object

Access: public

[ Top ]