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

Class: HTML_QuickForm_Renderer_Object

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

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_Object

A concrete renderer for HTML_QuickForm, makes an object from form contents


Author(s):

Variables

Methods


Child classes:

HTML_QuickForm_Renderer_ObjectFlexy
QuickForm renderer for Flexy template engine, static version.

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 30]
A concrete renderer for HTML_QuickForm, makes an object from form contents

Based on HTML_Quickform_Renderer_Array code




Tags:

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


[ Top ]


Class Variables

$_collectHidden =  false

[line 72]

true: collect all hidden elements into string; false: process them as usual form elements


Type:   bool


[ Top ]

$_currentGroup =  null

[line 54]

Object representing current group


Type:   object


[ Top ]

$_currentSection =

[line 48]

Current section number


Type:   integer


[ Top ]

$_elementStyles = array()

[line 66]

Additional style information for different elements


Type:   array


[ Top ]

$_elementType =  'QuickFormElement'

[line 60]

Class of Element Objects


Type:   object


[ Top ]

$_obj =  null

[line 36]

The object being generated


Type:   object


[ Top ]

$_sectionCount =

[line 42]

Number of sections in the form (i.e. number of headers in it)


Type:   integer


[ Top ]



Class Methods


constructor HTML_QuickForm_Renderer_Object [line 81]

HTML_QuickForm_Renderer_Object HTML_QuickForm_Renderer_Object( [collecthidden $collecthidden = false])

Constructor



Tags:

access:  public


Parameters:

collecthidden   $collecthidden   bool true: collect all hidden elements

[ Top ]

method finishGroup [line 159]

void finishGroup( &$group)



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

Parameters:

   &$group  

[ Top ]

method renderElement [line 131]

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



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

Parameters:

   &$element  
   $required  
   $error  

[ Top ]

method renderHeader [line 123]

void renderHeader( &$header)



Overridden in child classes as:

HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()

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

Parameters:

   &$header  

[ Top ]

method renderHidden [line 141]

void renderHidden( &$element)



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

Parameters:

   &$element  

[ Top ]

method setElementStyle [line 228]

void setElementStyle( $elementName, [ $styleName = null])



Parameters:

   $elementName  
   $styleName  

[ Top ]

method setElementType [line 102]

void setElementType( type $type)

Set the class of the form elements. Defaults to QuickformElement.



Tags:

access:  public


Parameters:

type   $type   string Name of element class

[ Top ]

method startForm [line 107]

void startForm( &$form)



Overrides HTML_QuickForm_Renderer::startForm() (Called when visiting a form, before processing any form elements)

Parameters:

   &$form  

[ Top ]

method startGroup [line 150]

void startGroup( &$group, $required, $error)



Overridden in child classes as:

HTML_QuickForm_Renderer_ObjectFlexy::startGroup()

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

Parameters:

   &$group  
   $required  
   $error  

[ Top ]

method toObject [line 92]

void toObject( )

Return the rendered Object



Tags:

access:  public


[ Top ]


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