Class: HTML_QuickForm_Renderer_ObjectFlexy

Source Location: /main/inc/lib/pear/HTML/QuickForm/Renderer/ObjectFlexy.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_Object
      |
      --HTML_QuickForm_Renderer_ObjectFlexy

QuickForm renderer for Flexy template engine, static version.

Author(s):

Alexey Borzov <borz_off@cs.msu.su>

Inherited Variables

Class: HTML_QuickForm_Renderer_Object

HTML_QuickForm_Renderer_Object::$_collectHidden
HTML_QuickForm_Renderer_Object::$_currentGroup
HTML_QuickForm_Renderer_Object::$_currentSection
HTML_QuickForm_Renderer_Object::$_elementStyles
HTML_QuickForm_Renderer_Object::$_obj
HTML_QuickForm_Renderer_Object::$_sectionCount

Inherited Methods

Class: HTML_QuickForm_Renderer_Object

HTML_QuickForm_Renderer_Object::HTML_QuickForm_Renderer_Object(): Constructor
HTML_QuickForm_Renderer_Object::finishGroup()
HTML_QuickForm_Renderer_Object::renderElement()
HTML_QuickForm_Renderer_Object::renderHeader()
HTML_QuickForm_Renderer_Object::renderHidden()
HTML_QuickForm_Renderer_Object::setElementStyle()
HTML_QuickForm_Renderer_Object::setElementType(): Set the class of the form elements. Defaults to QuickformElement.
HTML_QuickForm_Renderer_Object::startForm()
HTML_QuickForm_Renderer_Object::startGroup()
HTML_QuickForm_Renderer_Object::toObject(): Return the rendered Object
HTML_QuickForm_Renderer_Object::_elementToObject(): Creates an object representing an element
HTML_QuickForm_Renderer_Object::_storeObject(): Stores an object representation of an element in the form array

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 45]
QuickForm renderer for Flexy template engine, static version.

A static renderer for HTML_Quickform. Makes a QuickFormFlexyObject from the form content suitable for use with a Flexy template

Usage: $form =& new HTML_QuickForm('form', 'POST'); $template =& new HTML_Template_Flexy(); $renderer =& new HTML_QuickForm_Renderer_ObjectFlexy(&$template); $renderer->setHtmlTemplate("html.html"); $renderer->setLabelTemplate("label.html"); $form->accept($renderer); $view = new StdClass; $view->form = $renderer->toObject(); $template->compile("mytemplate.html");

Based on the code for HTML_QuickForm_Renderer_ArraySmarty

Tags:

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

[ Top ]

Class Variables

$label = ''

[line 77]

Name of template file for form labels

Tags:

see:

setErrorTemplate()

Type:

string

[ Top ]

$_elementIdx =

[line 57]

Current element index

Type:

integer

[ Top ]

$_elementType = 'QuickformFlexyElement'

[line 84]

Class of the element objects, so you can add your own

element methods

Type:	string
Overrides:	Array

[ Top ]

$_flexy =

[line 51]

HTML_Template_Flexy instance

Type:

object

[ Top ]

$_groupElementIdx = 0

[line 63]

The current element index inside a group

Type:

integer

[ Top ]

$_html = ''

[line 70]

Name of template file for form html

Tags:

see:

setRequiredTemplate()

Type:

string

[ Top ]

Class Methods

constructor HTML_QuickForm_Renderer_ObjectFlexy [line 92]

HTML_QuickForm_Renderer_ObjectFlexy HTML_QuickForm_Renderer_ObjectFlexy(
$flexy
&$flexy)

Constructor

Tags:

public:

Parameters:

$flexy

&$flexy

object HTML_Template_Flexy instance

[ Top ]

method renderHeader [line 99]

void renderHeader(

&$header)

Overrides HTML_QuickForm_Renderer_Object::renderHeader() (parent method not documented)

Parameters:

&$header

[ Top ]

method setHtmlTemplate [line 213]

void setHtmlTemplate(
template
$template)

Set the filename of the template to render html elements.

In your template, {html} is replaced by the unmodified html. If the element is required, {required} will be true. Eg. {if:error} <font color="red" size="1">{error:h}</font>
{end:} {html:h}

Tags:

access:

public

Parameters:

template

$template

string Filename of template

[ Top ]

method setLabelTemplate [line 233]

void setLabelTemplate(
template
$template)

Set the filename of the template to render form labels In your template, {label} is replaced by the unmodified label.

{error} will be set to the error, if any. {required} will be true if this is a required field Eg. {if:required} <font color="orange" size="1">*</font> {end:} {label:h}

Tags:

access:

public

Parameters:

template

$template

string Filename of template

[ Top ]

method startGroup [line 109]

void startGroup(

&$group, 
$required, 
$error)

Overrides HTML_QuickForm_Renderer_Object::startGroup() (parent method not documented)

Parameters:

	&$group
	$required
	$error

[ Top ]

method _elementToObject [line 125]

object _elementToObject(
element
&$element, required
$required, error
$error)

Creates an object representing an element containing the key for storing this

Tags:

access:

private

Overrides HTML_QuickForm_Renderer_Object::_elementToObject() (Creates an object representing an element)

Parameters:

element	&$element	object An HTML_QuickForm_element object
required	$required	bool Whether an element is required
error	$error	string Error associated with the element

[ Top ]

method _renderHtml [line 244]

void _renderHtml(

&$ret)

Parameters:

&$ret

[ Top ]

method _renderLabel [line 238]

void _renderLabel(

&$ret)

Parameters:

&$ret

[ Top ]

method _storeObject [line 185]

void _storeObject(
elObj
$elObj)

Stores an object representation of an element in the QuickformFormObject instance

Tags:

access:

private

Overrides HTML_QuickForm_Renderer_Object::_storeObject() (Stores an object representation of an element in the form array)

Parameters:

elObj

$elObj

object Object representation of an element

[ Top ]

Documentation generated on Thu, 12 Jun 2008 14:07:49 -0500 by phpDocumentor 1.4.1