apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
HTML_QuickForm
apidoc
QuickForm


Classes:
HTML_QuickForm
   HTML_QuickForm
   HTML_QuickForm_advcheckbox
   HTML_QuickForm_autocomplete
   HTML_QuickForm_button
   HTML_QuickForm_checkbox
   HTML_QuickForm_date
   HTML_QuickForm_element
   HTML_QuickForm_Error
   HTML_QuickForm_file
   HTML_QuickForm_group
   HTML_QuickForm_header
   HTML_QuickForm_hidden
   HTML_QuickForm_hiddenselect
   HTML_QuickForm_hierselect
   HTML_QuickForm_html
   HTML_QuickForm_image
   HTML_QuickForm_input
   HTML_QuickForm_link
   HTML_QuickForm_password
   HTML_QuickForm_radio
   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_reset
   HTML_QuickForm_Rule
   HTML_QuickForm_RuleRegistry
   HTML_QuickForm_Rule_Callback
   HTML_QuickForm_Rule_Email
   HTML_QuickForm_Rule_Range
   HTML_QuickForm_Rule_Regex
   HTML_QuickForm_Rule_Required
   HTML_QuickForm_select
   HTML_QuickForm_static
   HTML_QuickForm_submit
   HTML_QuickForm_text
   HTML_QuickForm_textarea
   HTML_QuickForm_xbutton
   QuickformElement
   QuickformFlexyElement
   QuickformFlexyForm
   QuickformForm
   RuleNumericRange
Files:
subpackage HTML_QuickForm
QuickHtml_example.php

Class: HTML_QuickForm_Renderer_Default

Source Location: /HTML_QuickForm-3.2.5/QuickForm/Renderer/Default.php

Class Overview

HTML_QuickForm_Renderer
   |
   --HTML_QuickForm_Renderer_Default

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


Author(s):

Methods

Child classes:

HTML_QuickForm_Renderer_QuickHtml
A renderer that makes it quick and easy to create customized forms.

Inherited Variables

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 31]
A concrete renderer for HTML_QuickForm, based on QuickForm 2.x built-in one


[ Top ]

Method Detail

HTML_QuickForm_Renderer_Default (Constructor)   [line 144]

HTML_QuickForm_Renderer_Default HTML_QuickForm_Renderer_Default( )

Constructor
  • Access: public

[ Top ]

clearAllTemplates   [line 466]

void clearAllTemplates( )

Clears all the HTML out of the templates that surround notes, elements, etc.

Useful when you want to use addData() to create a completely custom form look

  • Access: public

[ Top ]

finishForm   [line 183]

void finishForm( object An &$form)

Called when visiting a form, after processing all form elements Adds required note, form attributes, validation javascript and form content.
  • Access: public

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

Parameters:

object An   &$form   —  HTML_QuickForm object being visited

[ Top ]

finishGroup   [line 353]

void finishGroup( object An &$group)

Called when visiting a group, after processing all group elements
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_QuickHtml::finishGroup()
Gets the html for the group element and adds it to the array by calling parent::finishGroup()

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

Parameters:

object An   &$group   —  HTML_QuickForm_group object being visited

[ Top ]

renderElement   [line 281]

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

Renders an element Html Called when visiting an element
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_QuickHtml::renderElement()
Gets the html for an element and adds it to the array by calling parent::renderElement()

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

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 ]

renderHeader   [line 211]

void renderHeader( object An &$header)

Called when visiting a header element
  • Access: public

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

Parameters:

object An   &$header   —  HTML_QuickForm_header element being visited

[ Top ]

renderHidden   [line 310]

void renderHidden( object An &$element)

Renders an hidden element Called when visiting a hidden element
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_QuickHtml::renderHidden()
Gets the html for a hidden element and adds it to the array.

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

Parameters:

object An   &$element   —  HTML_QuickForm_hidden object being visited

[ Top ]

renderHtml   [line 322]

void renderHtml( object An &$data)

Called when visiting a raw HTML/text pseudo-element
  • Access: public

Overrides HTML_QuickForm_Renderer::renderHtml() (Called when visiting a raw HTML/text pseudo-element)

Parameters:

object An   &$data   —  HTML_QuickForm_html element being visited

[ Top ]

setElementTemplate   [line 383]

void setElementTemplate( string $html, [string $element = null])

Sets element template
  • Access: public

Parameters:

string   $html   —  The HTML surrounding an element
string   $element   —  (optional) Name of the element to apply template for

[ Top ]

setFormTemplate   [line 442]

void setFormTemplate( string $html)

Sets form template
  • Access: public

Parameters:

string   $html   —  The HTML surrounding the form tags

[ Top ]

setGroupElementTemplate   [line 418]

void setGroupElementTemplate( string $html, string $group)

Sets element template for elements within a group
  • Access: public

Parameters:

string   $html   —  The HTML surrounding an element
string   $group   —  Name of the group to apply template for

[ Top ]

setGroupTemplate   [line 405]

void setGroupTemplate( string $html, string $group)

Sets template for a group wrapper

This template is contained within a group-as-element template set via setTemplate() and contains group's element templates, set via setGroupElementTemplate()

  • Access: public

Parameters:

string   $html   —  The HTML surrounding group elements
string   $group   —  Name of the group to apply template for

[ Top ]

setHeaderTemplate   [line 430]

void setHeaderTemplate( string $html)

Sets header template
  • Access: public

Parameters:

string   $html   —  The HTML surrounding the header

[ Top ]

setRequiredNoteTemplate   [line 454]

void setRequiredNoteTemplate( string $html)

Sets the note indicating required fields template
  • Access: public

Parameters:

string   $html   —  The HTML surrounding the required note

[ Top ]

startForm   [line 169]

void startForm( object An &$form)

Called when visiting a form, before processing any form elements
  • Access: public

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

Parameters:

object An   &$form   —  HTML_QuickForm object being visited

[ Top ]

startGroup   [line 336]

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

Called when visiting a group, before processing any group elements
  • Access: public

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

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 ]

toHtml   [line 155]

string toHtml( )

returns the HTML generated for the form
  • Access: public

Overridden in child classes as:

HTML_QuickForm_Renderer_QuickHtml::toHtml()
returns the HTML generated for the form

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:16:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.