HTML_QuickForm
[ class tree: HTML_QuickForm ] [ index: HTML_QuickForm ] [ all elements ]

Class: HTML_QuickForm_Renderer

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

Class Overview


An abstract base class for QuickForm renderers


Author(s):

Version:

  • Release: 3.2.13

Methods


Child classes:

HTML_QuickForm_Renderer_Array
A concrete renderer for HTML_QuickForm, makes an array of form contents
HTML_QuickForm_Renderer_Object
A concrete renderer for HTML_QuickForm, makes an object from form contents
HTML_QuickForm_Renderer_ITDynamic
A concrete renderer for HTML_QuickForm, using Integrated Templates.
HTML_QuickForm_Renderer_ITStatic
A static renderer for HTML_QuickForm compatible with HTML_Template_IT and HTML_Template_Sigma.
HTML_QuickForm_Renderer_Default
A concrete renderer for HTML_QuickForm, based on QuickForm 2.x built-in one

Inherited Variables

Inherited Methods


Class Details

[line 36]
An abstract base class for QuickForm renderers

The class implements a Visitor design pattern

  • Author: Alexey Borzov <avb@php.net>
  • Version: Release: 3.2.13
  • Abstract:
  • Since: 3.0


[ Top ]


Method Detail

HTML_QuickForm_Renderer (Constructor)   [line 43]

HTML_QuickForm_Renderer HTML_QuickForm_Renderer( )

Constructor
  • Access: public

[ Top ]

finishForm   [line 68]

void finishForm( HTML_QuickForm &$form)

Called when visiting a form, after processing all form elements
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_ITDynamic::finishForm()
HTML_QuickForm_Renderer_ITStatic::finishForm()
Called when visiting a form, after processing all form elements
HTML_QuickForm_Renderer_Default::finishForm()
Called when visiting a form, after processing all form elements Adds required note, form attributes, validation javascript and form content.

Parameters:

HTML_QuickForm   &$form     a form being visited

[ Top ]

finishGroup   [line 153]

void finishGroup( HTML_QuickForm_group &$group)

Called when visiting a group, after processing all group elements
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::finishGroup()
HTML_QuickForm_Renderer_Object::finishGroup()
HTML_QuickForm_Renderer_ITDynamic::finishGroup()
HTML_QuickForm_Renderer_ITStatic::finishGroup()
Called when visiting a group, after processing all group elements
HTML_QuickForm_Renderer_Default::finishGroup()
Called when visiting a group, after processing all group elements
HTML_QuickForm_Renderer_QuickHtml::finishGroup()
Gets the html for the group element and adds it to the array by calling parent::finishGroup()

Parameters:

HTML_QuickForm_group   &$group     A group being visited

[ Top ]

renderElement   [line 96]

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

Called when visiting an element
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderElement()
HTML_QuickForm_Renderer_Object::renderElement()
HTML_QuickForm_Renderer_ITDynamic::renderElement()
HTML_QuickForm_Renderer_ITStatic::renderElement()
Called when visiting an element
HTML_QuickForm_Renderer_Default::renderElement()
Renders an element Html Called when visiting an element
HTML_QuickForm_Renderer_QuickHtml::renderElement()
Gets the html for an element and adds it to the array by calling parent::renderElement()

Parameters:

HTML_QuickForm_element   &$element     form element being visited
bool   $required     Whether an element is required
string   $error     An error message associated with an element

[ Top ]

renderHeader   [line 81]

void renderHeader( HTML_QuickForm_header &$header)

Called when visiting a header element
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderHeader()
HTML_QuickForm_Renderer_ArraySmarty::renderHeader()
Called when visiting a header element
HTML_QuickForm_Renderer_Object::renderHeader()
HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()
HTML_QuickForm_Renderer_ITDynamic::renderHeader()
HTML_QuickForm_Renderer_ITStatic::renderHeader()
Called when visiting a header element
HTML_QuickForm_Renderer_Default::renderHeader()
Called when visiting a header element

Parameters:

HTML_QuickForm_header   &$header     a header element being visited

[ Top ]

renderHidden   [line 109]

void renderHidden( HTML_QuickForm_element &$element)

Called when visiting a hidden element
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::renderHidden()
HTML_QuickForm_Renderer_Object::renderHidden()
HTML_QuickForm_Renderer_ITDynamic::renderHidden()
HTML_QuickForm_Renderer_ITStatic::renderHidden()
Called when visiting a hidden element
HTML_QuickForm_Renderer_Default::renderHidden()
Renders an hidden element Called when visiting a hidden element
HTML_QuickForm_Renderer_QuickHtml::renderHidden()
Gets the html for a hidden element and adds it to the array.

Parameters:

HTML_QuickForm_element   &$element     a hidden element being visited

[ Top ]

renderHtml   [line 125]

void renderHtml( HTML_QuickForm_html &$data)

Called when visiting a raw HTML/text pseudo-element

Only implemented in Default renderer. Usage of 'html' elements is discouraged, templates should be used instead.

  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Default::renderHtml()
Called when visiting a raw HTML/text pseudo-element

Parameters:

HTML_QuickForm_html   &$data     a 'raw html' element being visited

[ Top ]

startForm   [line 55]

void startForm( HTML_QuickForm &$form)

Called when visiting a form, before processing any form elements
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::startForm()
HTML_QuickForm_Renderer_Object::startForm()
HTML_QuickForm_Renderer_ITStatic::startForm()
Called when visiting a form, before processing any form elements
HTML_QuickForm_Renderer_Default::startForm()
Called when visiting a form, before processing any form elements

Parameters:

HTML_QuickForm   &$form     a form being visited

[ Top ]

startGroup   [line 140]

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

Called when visiting a group, before processing any group elements
  • Abstract:
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_Array::startGroup()
HTML_QuickForm_Renderer_ArraySmarty::startGroup()
Called when visiting a group, before processing any group elements
HTML_QuickForm_Renderer_Object::startGroup()
HTML_QuickForm_Renderer_ObjectFlexy::startGroup()
HTML_QuickForm_Renderer_ITDynamic::startGroup()
HTML_QuickForm_Renderer_ITStatic::startGroup()
Called when visiting a group, before processing any group elements
HTML_QuickForm_Renderer_Default::startGroup()
Called when visiting a group, before processing any group elements

Parameters:

HTML_QuickForm_group   &$group     A group being visited
bool   $required     Whether a group is required
string   $error     An error message associated with a group

[ Top ]


Documentation generated on Sat, 01 Oct 2011 09:00:19 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.