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

Class: HTML_QuickForm_Renderer_ITDynamic

Source Location: /pear/HTML/QuickForm/Renderer/ITDynamic.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_ITDynamic

A concrete renderer for HTML_QuickForm, using Integrated Templates.


Author(s):

Variables

Methods


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 37]
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.




Tags:

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


[ Top ]


Class Variables

$_elementBlocks = array()

[line 73]

Blocks to use for different elements


Type:   array


[ Top ]

$_errors = array()

[line 49]

The errors that were not shown near concrete fields go here


Type:   array


[ Top ]

$_groupElementIdx =  0

[line 67]

The current element index inside a group


Type:   integer


[ Top ]

$_groupSeparator =  null

[line 61]

A separator for group elements


Type:   mixed


[ Top ]

$_headerBlock =  null

[line 79]

Block to use for headers


Type:   string


[ Top ]

$_showRequired =  false

[line 55]

Show the block with required note?


Type:   bool


[ Top ]

$_tpl =  null

[line 43]

A template class (HTML_Template_ITX or HTML_Template_Sigma) instance


Type:   object


[ Top ]



Class Methods


constructor HTML_QuickForm_Renderer_ITDynamic [line 87]

HTML_QuickForm_Renderer_ITDynamic HTML_QuickForm_Renderer_ITDynamic( object An &$tpl)

Constructor



Parameters:

object An   &$tpl   HTML_Template_ITX/HTML_Template_Sigma object to use

[ Top ]

method finishForm [line 95]

void finishForm( &$form)



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

Parameters:

   &$form  

[ Top ]

method finishGroup [line 214]

void finishGroup( &$group)



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

Parameters:

   &$group  

[ Top ]

method renderElement [line 127]

void renderElement( &$element, $required, $error)



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

Parameters:

   &$element  
   $required  
   $error  

[ Top ]

method renderHeader [line 115]

void renderHeader( &$header)



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

Parameters:

   &$header  

[ Top ]

method renderHidden [line 182]

void renderHidden( &$element)



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

Parameters:

   &$element  

[ Top ]

method setElementBlock [line 265]

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

Sets the block to use for element rendering



Tags:

access:  public


Parameters:

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

[ Top ]

method setHeaderBlock [line 282]

void setHeaderBlock( string $blockName)

Sets the name of a block to use for header rendering



Tags:

access:  public


Parameters:

string   $blockName   block name

[ Top ]

method startGroup [line 189]

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 ]


Documentation generated on Sun, 08 Jan 2012 17:51:52 +0100 by phpDocumentor 1.4.3