default
[ class tree: default ] [ index: default ] [ all elements ]
Packages:
default
Cache_Lite
Crypt
HTML_Common
HTML_QuickForm
HTTP_Request
Image_Text
Log
Mail
Mail_Mime
Net_SMTP
PEAR
QuickForm
Smarty
SmartyGettext
Text_CAPTCHA
Text_Password
Welcompose
Welcompose_Plugins
XML_RPC


Files:
advcheckbox.php
Array.php
ArraySmarty.php
autocomplete.php
button.php
Callback.php
checkbox.php
date.php
Default.php
defaults.inc.php
element.php
Email.php
Equation.php
Figlet.php
file.php
group.php
header.php
hidden.php
hiddenselect.php
hierselect.php
html.php
image.php
Image.php
input.php
In_Array_Keys.php
Is_Equal.php
ITDynamic.php
ITStatic.php
link.php
markdown.php
modifier.date_atom.php
modifier.date_rss20.php
modifier.increment.php
Object.php
ObjectFlexy.php
password.php
QuickForm.php
radio.php
Range.php
Regex.php
Renderer.php
Request.php
Required.php
reset.php
Rule.php
RuleRegistry.php
select.php
Socket.php
static.php
submit.php
sys.inc.php
text.php
textarea.php
textile.php
URL.php
Word.php
xbutton.php

Classes:
HTML_QuickForm_Renderer
HTML_QuickForm_Renderer_Array
HTML_QuickForm_Renderer_ArraySmarty
HTML_QuickForm_Renderer_Default
HTML_QuickForm_Renderer_ITDynamic
HTML_QuickForm_Renderer_ITStatic
HTML_QuickForm_Renderer_Object
HTML_QuickForm_Renderer_ObjectFlexy
HTML_QuickForm_Rule
HTML_QuickForm_RuleRegistry
HTML_QuickForm_Rule_Callback
HTML_QuickForm_Rule_Email
HTML_QuickForm_Rule_In_Array_Keys
HTML_QuickForm_Rule_Is_Equal
HTML_QuickForm_Rule_Range
HTML_QuickForm_Rule_Regex
HTML_QuickForm_Rule_Required
HTTP_Request
HTTP_Response
Net_URL
QuickformElement
QuickformFlexyElement
QuickformFlexyForm
QuickformForm
Textile

Class: HTML_QuickForm_Renderer

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

Class Overview




An abstract base class for QuickForm renderers




Author(s):






        

        






Methods















Child classes:






HTML_QuickForm_Renderer_Array

	
A concrete renderer for HTML_QuickForm, makes an array of form contents






HTML_QuickForm_Renderer_Default

	
A concrete renderer for HTML_QuickForm,  based on QuickForm 2.x built-in one






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_Object

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

















Class Details



[line 29]

An abstract base class for QuickForm renderers

The class implements a Visitor design pattern





Tags:





  

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

  

    abstract:  
  










[ Top ]








Class Methods




  

	
	
constructor HTML_QuickForm_Renderer [line 36]

	

    

    

		HTML_QuickForm_Renderer HTML_QuickForm_Renderer(
)
    

    


	
		Constructor





Tags:





  

    access:  public
  









	
        
[ Top ]

  

  

	
	
method finishForm [line 61]

	

    

    

		void finishForm(
object An
&$form)
    

    


	
		Called when visiting a form, after processing all form elements





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
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.

	

		

	
HTML_QuickForm_Renderer_ITDynamic::finishForm()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::finishForm()

		
Called when visiting a form, after processing all form elements

	

	

	
        
Parameters:

    

    

          

        object An  
        &$form  
        HTML_QuickForm object being visited
      

        

    


        
[ Top ]

  

  

	
	
method finishGroup [line 145]

	

    

    

		void finishGroup(
object An
&$group)
    

    


	
		Called when visiting a group, after processing all group elements





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
HTML_QuickForm_Renderer_Array::finishGroup()

		

	

		

	
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()

	

		

	
HTML_QuickForm_Renderer_ITDynamic::finishGroup()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::finishGroup()

		
Called when visiting a group, after processing all group elements

	

		

	
HTML_QuickForm_Renderer_Object::finishGroup()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$group  
        HTML_QuickForm_group object being visited
      

        

    


        
[ Top ]

  

  

	
	
method renderElement [line 89]

	

    

    

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

    


	
		Called when visiting an element





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
HTML_QuickForm_Renderer_Array::renderElement()

		

	

		

	
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()

	

		

	
HTML_QuickForm_Renderer_ITDynamic::renderElement()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::renderElement()

		
Called when visiting an element

	

		

	
HTML_QuickForm_Renderer_Object::renderElement()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$element  
        HTML_QuickForm_element object being visited
      

          

        bool  
        $required  
        Whether an element is required
      

          

        string  
        $error  
        An error message associated with an element
      

        

    


        
[ Top ]

  

  

	
	
method renderHeader [line 74]

	

    

    

		void renderHeader(
object An
&$header)
    

    


	
		Called when visiting a header element





Tags:





  

    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_Default::renderHeader()

		
Called when visiting a header element

	

		

	
HTML_QuickForm_Renderer_ITDynamic::renderHeader()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::renderHeader()

		
Called when visiting a header element

	

		

	
HTML_QuickForm_Renderer_Object::renderHeader()

		

	

		

	
HTML_QuickForm_Renderer_ObjectFlexy::renderHeader()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$header  
        HTML_QuickForm_header element being visited
      

        

    


        
[ Top ]

  

  

	
	
method renderHidden [line 102]

	

    

    

		void renderHidden(
object An
&$element)
    

    


	
		Called when visiting a hidden element





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
HTML_QuickForm_Renderer_Array::renderHidden()

		

	

		

	
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.

	

		

	
HTML_QuickForm_Renderer_ITDynamic::renderHidden()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::renderHidden()

		
Called when visiting a hidden element

	

		

	
HTML_QuickForm_Renderer_Object::renderHidden()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$element  
        HTML_QuickForm_hidden object being visited
      

        

    


        
[ Top ]

  

  

	
	
method renderHtml [line 117]

	

    

    

		void renderHtml(
object An
&$data)
    

    


	
		Called when visiting a raw HTML/text pseudo-element

Seems that this should not be used when using a template-based renderer





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
HTML_QuickForm_Renderer_Default::renderHtml()

		
Called when visiting a raw HTML/text pseudo-element

	

	

	
        
Parameters:

    

    

          

        object An  
        &$data  
        HTML_QuickForm_html element being visited
      

        

    


        
[ Top ]

  

  

	
	
method startForm [line 48]

	

    

    

		void startForm(
object An
&$form)
    

    


	
		Called when visiting a form, before processing any form elements





Tags:





  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
HTML_QuickForm_Renderer_Array::startForm()

		

	

		

	
HTML_QuickForm_Renderer_Default::startForm()

		
Called when visiting a form, before processing any form elements

	

		

	
HTML_QuickForm_Renderer_ITStatic::startForm()

		
Called when visiting a form, before processing any form elements

	

		

	
HTML_QuickForm_Renderer_Object::startForm()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$form  
        HTML_QuickForm object being visited
      

        

    


        
[ Top ]

  

  

	
	
method startGroup [line 132]

	

    

    

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

    


	
		Called when visiting a group, before processing any group elements





Tags:





  

    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_Default::startGroup()

		
Called when visiting a group, before processing any group elements

	

		

	
HTML_QuickForm_Renderer_ITDynamic::startGroup()

		

	

		

	
HTML_QuickForm_Renderer_ITStatic::startGroup()

		
Called when visiting a group, before processing any group elements

	

		

	
HTML_QuickForm_Renderer_Object::startGroup()

		

	

		

	
HTML_QuickForm_Renderer_ObjectFlexy::startGroup()

		

	

	

	
        
Parameters:

    

    

          

        object An  
        &$group  
        HTML_QuickForm_group object being visited
      

          

        bool  
        $required  
        Whether a group is required
      

          

        string  
        $error  
        An error message associated with a group
      

        

    


        
[ Top ]

  






        

		    

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