Class: HTML_QuickForm_Renderer_ITDynamic

Source Location: /HTML_QuickForm-3.2.14/QuickForm/Renderer/ITDynamic.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_ITDynamic

A concrete renderer for HTML_QuickForm, using Integrated Templates.

Author(s):

Alexey Borzov <avb at php.net>

Version:

Release: 3.2.14

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 46]
A concrete renderer for HTML_QuickForm, using Integrated Templates.

This is a "dynamic" renderer, which means that concrete form look is defined at runtime. This also means that you can define one template file for all your forms. That template should contain a block for every element 'look' appearing in your forms and also some special blocks (consult the examples). If a special block is not set for an element, the renderer falls back to a default one.

Author: Alexey Borzov <avb@php.net>
Version: Release: 3.2.14
Since: 3.0

[ Top ]

Method Detail

HTML_QuickForm_Renderer_ITDynamic (Constructor) [line 100]

HTML_QuickForm_Renderer_ITDynamic HTML_QuickForm_Renderer_ITDynamic(
HTML_Template_ITX|HTML_Template_Sigma
&$tpl)

Constructor

Parameters:

HTML_Template_ITX|HTML_Template_Sigma &$tpl — Template object to use

[ Top ]

finishForm [line 108]

void finishForm(

&$form)

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

Parameters:

&$form —

[ Top ]

finishGroup [line 227]

void finishGroup(

&$group)

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

Parameters:

&$group —

[ Top ]

renderElement [line 140]

void renderElement(

&$element, 
$required, 
$error)

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

Parameters:

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

[ Top ]

renderHeader [line 128]

void renderHeader(

&$header)

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

Parameters:

&$header —

[ Top ]

renderHidden [line 195]

void renderHidden(

&$element)

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

Parameters:

&$element —

[ Top ]

setElementBlock [line 278]

void setElementBlock(
mixed
$elementName, [string
$blockName = null])

Sets the block to use for element rendering

Access: public

Parameters:

mixed	`$elementName`	—	element name or array ('element name' => 'block name')
string	`$blockName`	—	block name if $elementName is not an array

[ Top ]

setHeaderBlock [line 295]

void setHeaderBlock(
string
$blockName)

Sets the name of a block to use for header rendering

Access: public

Parameters:

string $blockName — block name

[ Top ]

startGroup [line 202]

void startGroup(

&$group, 
$required, 
$error)

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

Parameters:

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

[ Top ]