Class: HTML_QuickForm_Renderer_ObjectFlexy

Source Location: /HTML_QuickForm-3.2.14/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):

Ron McClain <ron at humaniq.com>

Version:

Release: 3.2.14

Methods

Inherited Variables

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

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 56]
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

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

[ Top ]

Method Detail

HTML_QuickForm_Renderer_ObjectFlexy (Constructor) [line 107]

HTML_QuickForm_Renderer_ObjectFlexy HTML_QuickForm_Renderer_ObjectFlexy(
HTML_Template_Flexy
&$flexy)

Constructor

Public:

Parameters:

HTML_Template_Flexy &$flexy — template object to use

[ Top ]

renderHeader [line 114]

void renderHeader(

&$header)

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

Parameters:

&$header —

[ Top ]

setHtmlTemplate [line 230]

void setHtmlTemplate(
string
$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}
   {error:h}

 {end:}
 {html:h}

Access: public

Parameters:

string $template — Filename of template

[ Top ]

setLabelTemplate [line 252]

void setLabelTemplate(
string
$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}
 *
 {end:}
 {label:h}

Access: public

Parameters:

string $template — Filename of template

[ Top ]

startGroup [line 124]

void startGroup(

&$group, 
$required, 
$error)

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

Parameters:

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

[ Top ]