Class: HTML_QuickForm2_Renderer_Default

Source Location: /HTML_QuickForm2-0.3.0/QuickForm2/Renderer/Default.php

Class Overview

HTML_QuickForm2_Renderer
   |
   --HTML_QuickForm2_Renderer_Default

Default renderer for QuickForm2

Author(s):

Bertrand Mansion <golgote at mamasam.com>
Alexey Borzov <avb at php.net>

Version:

Release: 0.3.0

Inherited Variables

Class: HTML_QuickForm2_Renderer

HTML_QuickForm2_Renderer::$options

Inherited Methods

Class: HTML_QuickForm2_Renderer

HTML_QuickForm2_Renderer::__construct(): Constructor
HTML_QuickForm2_Renderer::exportMethods(): Returns an array of "published" method names that should be callable through proxy
HTML_QuickForm2_Renderer::factory(): Creates a new renderer instance of the given type
HTML_QuickForm2_Renderer::finishContainer(): Finishes rendering a generic container, called after processing contained elements
HTML_QuickForm2_Renderer::finishForm(): Finishes rendering a form, called after processing contained elements
HTML_QuickForm2_Renderer::finishGroup(): Finishes rendering a group, called after processing grouped elements
HTML_QuickForm2_Renderer::getOption(): Returns the value(s) of the renderer option(s)
HTML_QuickForm2_Renderer::register(): Registers a new renderer type
HTML_QuickForm2_Renderer::registerPlugin(): Registers a plugin for a renderer type
HTML_QuickForm2_Renderer::renderElement(): Renders a generic element
HTML_QuickForm2_Renderer::renderHidden(): Renders a hidden element
HTML_QuickForm2_Renderer::setOption(): Sets the option(s) affecting renderer behaviour
HTML_QuickForm2_Renderer::startContainer(): Starts rendering a generic container, called before processing contained elements
HTML_QuickForm2_Renderer::startForm(): Starts rendering a form, called before processing contained elements
HTML_QuickForm2_Renderer::startGroup(): Starts rendering a group, called before processing grouped elements

Class Details

[line 73]
Default renderer for QuickForm2

Mostly a direct port of Default renderer from QuickForm 3.x package.

While almost everything in this class is defined as public, its properties and those methods that are not published (i.e. not in array returned by exportMethods()) will be available to renderer plugins only.

The following methods are published:

Author: Bertrand Mansion <golgote@mamasam.com>
Author: Alexey Borzov <avb@php.net>
Version: Release: 0.3.0

[ Top ]

Class Variables

$errors = array()

[line 97]

Array of validation errors if 'group_errors' option is on

Access: public

Type:

array

[ Top ]

$groupedTemplates = array(
        '' => array(
            'html_quickform2_element' => '{element}',
            'html_quickform2_container_fieldset' => '<fieldset{attributes}><qf:label><legend id="{id}-legend">{label}</legend></qf:label>{content}</fieldset>'
        ))

[line 130]

Default templates for elements of the given class within groups

Array has the form ('group id' => ('element class' => 'template', ...), ...), where empty group id corresponds to default grouped templates

Access: public

Type:

array

[ Top ]

$groupId = array()

[line 141]

Array containing IDs of the groups being rendered

Access: public

Type:

array

[ Top ]

$hasRequired = false

[line 79]

Whether the form contains required elements

Access: public

Type:

bool

[ Top ]

$hiddenHtml = ''

[line 91]

HTML for hidden elements if 'group_hiddens' option is on

Access: public

Type:

string

[ Top ]

$html = array(array())

[line 85]

HTML generated for the form

Access: public

Type:

array

[ Top ]

$templatesForClass = array(
        'html_quickform2_element_inputhidden' => '<div style="display: none;">{element}</div>',
        'html_quickform2' => '<div class="quickform">{errors}<form{attributes}>{hidden}{content}</form><qf:reqnote><div class="reqnote">{reqnote}</div></qf:reqnote></div>',
        'html_quickform2_container_fieldset' => '<fieldset{attributes}><qf:label><legend id="{id}-legend">{label}</legend></qf:label>{content}</fieldset>',
        'special:error' => array(
            'prefix'    => '<div class="errors"><qf:message><p>{message}</p></qf:message><ul><li>',
            'separator' => '</li><li>',
            'suffix'    => '</li></ul><qf:message><p>{message}</p></qf:message></div>'
        ),'html_quickform2_element'=>'<div class="row"><label for="{id}" class="element"><qf:required><span class="required">* </span></qf:required>{label}</label><div class="element<qf:error> error</qf:error>"><qf:error><span class="error">{error}</span><br /></qf:error>{element}</div></div>','html_quickform2_container_group'=>'<div class="row"><label class="element"><qf:required><span class="required">* </span></qf:required>{label}</label><div class="element group<qf:error> error</qf:error>"><qf:error><span class="error">{error}</span><br /></qf:error>{content}</div></div>')

[line 103]

Default templates for elements of the given class

Access: public

Type:

array

[ Top ]

$templatesForId = array()

[line 120]

Custom templates for elements with the given IDs

Access: public

Type:

array

[ Top ]

Method Detail

exportMethods [line 143]

void exportMethods(
)

Access: protected

Overrides HTML_QuickForm2_Renderer::exportMethods() (Returns an array of "published" method names that should be callable through proxy)

[ Top ]

findTemplate [line 433]

string findTemplate(
HTML_QuickForm2_Node
$element, [string
$default = '{element}'])

Finds a proper template for the element

Return: Template
Access: public

Parameters:

HTML_QuickForm2_Node	`$element`	—	Element being rendered
string	`$default`	—	Default template to use if not found

[ Top ]

finishContainer [line 295]

void finishContainer(
HTML_QuickForm2_Node
$container)

Finishes rendering a generic container, called after processing contained elements

Access: public

Overrides HTML_QuickForm2_Renderer::finishContainer() (Finishes rendering a generic container, called after processing contained elements)

Parameters:

HTML_QuickForm2_Node $container — Container being rendered

[ Top ]

finishForm [line 367]

void finishForm(
HTML_QuickForm2_Node
$form)

Finishes rendering a form, called after processing contained elements

Access: public

Overrides HTML_QuickForm2_Renderer::finishForm() (Finishes rendering a form, called after processing contained elements)

Parameters:

HTML_QuickForm2_Node $form — Form being rendered

[ Top ]

finishGroup [line 328]

void finishGroup(
HTML_QuickForm2_Node
$group)

Finishes rendering a group, called after processing grouped elements

Access: public

Overrides HTML_QuickForm2_Renderer::finishGroup() (Finishes rendering a group, called after processing grouped elements)

Parameters:

HTML_QuickForm2_Node $group — Group being rendered

[ Top ]

markRequired [line 481]

string markRequired(
string
$elTpl, bool
$required)

Marks element required or removes "required" block

Return: Template with processed "required" block
Access: public

Parameters:

string	`$elTpl`	—	Element template
bool	`$required`	—	Whether element is required

[ Top ]

outputError [line 500]

string outputError(
string
$elTpl, string
$error)

Outputs element error, removes empty error blocks

Return: Template with error substitutions done
Access: public

Parameters:

string	`$elTpl`	—	Element template
string	`$error`	—	Validation error for the element

[ Top ]

outputGroupedErrors [line 401]

string outputGroupedErrors(
)

Creates a error list if 'group_errors' option is true

Return: HTML with a list of all validation errors
Access: public

[ Top ]

outputLabel [line 521]

string outputLabel(
string
$elTpl, mixed
$label)

Outputs element's label(s), removes empty label blocks

Return: Template with label substitutions done
Access: public

Parameters:

string	`$elTpl`	—	Element template
mixed	`$label`	—	Element label(s)

[ Top ]

prepareTemplate [line 466]

string prepareTemplate(
string
$elTpl, HTML_QuickForm2_Node
$element)

Processes the element's template, adding label(s), required note and error message

Return: Template with some substitutions done
Access: public

Parameters:

string	`$elTpl`	—	Element template
HTML_QuickForm2_Node	`$element`	—	Element being rendered

[ Top ]

renderElement [line 257]

void renderElement(
HTML_QuickForm2_Node
$element)

Renders a generic element

Access: public

Overrides HTML_QuickForm2_Renderer::renderElement() (Renders a generic element)

Parameters:

HTML_QuickForm2_Node $element — Element being rendered

[ Top ]

renderHidden [line 269]

void renderHidden(
HTML_QuickForm2_Node
$element)

Renders a hidden element

Access: public

Overrides HTML_QuickForm2_Renderer::renderHidden() (Renders a hidden element)

Parameters:

HTML_QuickForm2_Node $element — Hidden element being rendered

[ Top ]

reset [line 230]

HTML_QuickForm2_Renderer_Default reset(
)

Resets the accumulated data

This method is called automatically by startForm() method, but should be called manually before calling other rendering methods separately.

Access: public

[ Top ]

setErrorTemplate [line 198]

HTML_QuickForm2_Renderer_Default setErrorTemplate(
array
$template)

Sets template for rendering validation errors

This template will be used if 'group_errors' option is set to true. The template array should contain 'prefix', 'suffix' and 'separator' keys.

Access: public

Parameters:

array $template — Template for validation errors

[ Top ]

setGroupedTemplateForClass [line 216]

HTML_QuickForm2_Renderer_Default setGroupedTemplateForClass(
string
$className, mixed
$template, [string
$groupId = ''])

Sets template for grouped form elements that are instances of the given class

Templates set via setTemplateForClass() will not be used for grouped form elements. When searching for a template to use, the renderer will first consider template set for a specific group id, only then the generic group templates.

Access: public

Parameters:

string	`$className`	—	Class name
mixed	`$template`	—	Template
string	`$groupId`	—	Group's id, will set generic group template if not given

[ Top ]

setTemplateForClass [line 165]

HTML_QuickForm2_Renderer_Default setTemplateForClass(
string
$className, mixed
$template)

Sets template for form elements that are instances of the given class

When searching for a template to use, renderer will check for templates set for element's class and its parent classes, until found. Thus a more specific template will override a more generic one.

Access: public

Parameters:

string	`$className`	—	Class name
mixed	`$template`	—	Template to use for elements of that class

[ Top ]

setTemplateForId [line 182]

HTML_QuickForm2_Renderer_Default setTemplateForId(
string
$id, mixed
$template)

Sets template for form element with the given id

If a template is set for an element via this method, it will be used. In the other case a generic template set by setTemplateForClass() or setGroupedTemplateForClass() will be used.

Access: public

Parameters:

string	`$id`	—	Element's id
mixed	`$template`	—	Template to use for rendering of that element

[ Top ]

startContainer [line 284]

void startContainer(
HTML_QuickForm2_Node
$container)

Starts rendering a generic container, called before processing contained elements

Access: public

Overrides HTML_QuickForm2_Renderer::startContainer() (Starts rendering a generic container, called before processing contained elements)

Parameters:

HTML_QuickForm2_Node $container — Container being rendered

[ Top ]

startForm [line 357]

void startForm(
HTML_QuickForm2_Node
$form)

Starts rendering a form, called before processing contained elements

Access: public

Overrides HTML_QuickForm2_Renderer::startForm() (Starts rendering a form, called before processing contained elements)

Parameters:

HTML_QuickForm2_Node $form — Form being rendered

[ Top ]

startGroup [line 317]

void startGroup(
HTML_QuickForm2_Node
$group)

Starts rendering a group, called before processing grouped elements

Access: public

Overrides HTML_QuickForm2_Renderer::startGroup() (Starts rendering a group, called before processing grouped elements)

Parameters:

HTML_QuickForm2_Node $group — Group being rendered

[ Top ]

__toString [line 246]

string __toString(
)

Returns generated HTML

Access: public

[ Top ]

Class: HTML_QuickForm2_Renderer_Default

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Class: HTML_QuickForm2_Renderer

Inherited Methods

Class: HTML_QuickForm2_Renderer

Class Details

Class Variables

$errors = array()

$groupedTemplates = array( '' => array( 'html_quickform2_element' => '{element}', 'html_quickform2_container_fieldset' => '<fieldset{attributes}><qf:label><legend id="{id}-legend">{label}</legend></qf:label>{content}</fieldset>' ))

$groupId = array()

$hasRequired = false

$hiddenHtml = ''

$html = array(array())

$templatesForId = array()

Method Detail

exportMethods [line 143]

findTemplate [line 433]

Parameters:

finishContainer [line 295]

Parameters:

finishForm [line 367]

Parameters:

finishGroup [line 328]

Parameters:

markRequired [line 481]

Parameters:

outputError [line 500]

Parameters:

outputGroupedErrors [line 401]

outputLabel [line 521]

Parameters:

prepareTemplate [line 466]

Parameters:

renderElement [line 257]

Parameters:

renderHidden [line 269]

Parameters:

reset [line 230]

setErrorTemplate [line 198]

Parameters:

setGroupedTemplateForClass [line 216]

Parameters:

setTemplateForClass [line 165]

Parameters:

setTemplateForId [line 182]

Parameters:

startContainer [line 284]

Parameters:

startForm [line 357]

Parameters:

startGroup [line 317]

Parameters:

__toString [line 246]

$groupedTemplates = array(
'' => array(
'html_quickform2_element' => '{element}',
'html_quickform2_container_fieldset' => '<fieldset{attributes}><qf:label><legend id="{id}-legend">{label}</legend></qf:label>{content}</fieldset>'
))