Documentation

Horde_Form_Renderer
in package

The Horde_Form_Renderer class provides HTML and other renderings of forms for the Horde_Form:: package.

Tags
author

Robert E. Coyle robertecoyle@hotmail.com

category

Horde

copyright

2001-2007 Robert E. Coyle

license

http://www.horde.org/licenses/lgpl21 LGPL

Table of Contents

$_attrColumnWidth  : string
Width of the attributes column.
$_cols  : mixed
$_encodeTitle  : bool
Does the title of the form contain HTML? If so, you are responsible for doing any needed escaping/sanitization yourself. Otherwise the title will be run through htmlspecialchars() before being output.
$_firstField  : mixed
$_forms  : mixed
$_helpMarker  : mixed
$_name  : mixed
$_requiredLegend  : mixed
$_requiredMarker  : mixed
$_showHeader  : mixed
$_stripedRows  : mixed
$_varRenderer  : mixed
__construct()  : mixed
_listAllFormVars()  : mixed
_renderBeginActive()  : mixed
Implementation specific begin function.
_renderBeginInactive()  : mixed
Implementation specific begin function.
_renderDescription()  : mixed
_renderEnd()  : mixed
Implementation specific end function.
_renderForm()  : mixed
_renderHeader()  : mixed
_renderSectionBegin()  : mixed
_renderSectionEnd()  : mixed
_renderSectionTabs()  : mixed
_renderSpacer()  : mixed
_renderSubmit()  : mixed
_renderVarDisplayBegin()  : mixed
_renderVarDisplayEnd()  : mixed
_renderVarInputBegin()  : mixed
_renderVarInputEnd()  : mixed
_sectionHeader()  : mixed
beginActive()  : mixed
beginInactive()  : mixed
close()  : mixed
encodeTitle()  : bool
Sets or returns whether the form title should be encoded with htmlspecialchars().
end()  : mixed
factory()  : Horde_Form_Renderer
Attempts to return a concrete Horde_Form_Renderer instance based on $renderer.
getFormVars()  : mixed
Horde_Form_Renderer()  : mixed
Construct a new Horde_Form_Renderer::.
listFormVars()  : mixed
open()  : mixed
renderFormActive()  : mixed
renderFormInactive()  : mixed
setAttrColumnWidth()  : mixed
showHeader()  : mixed
singleton()  : Horde_Form_Renderer
Attempts to return a reference to a concrete Horde_Form_Renderer instance based on $renderer. It will only create a new instance if no Horde_Form_Renderer instance with the same parameters currently exists.
submit()  : mixed

Properties

$_attrColumnWidth

Width of the attributes column.

public string $_attrColumnWidth = '15%'
Tags
access

private

$_encodeTitle

Does the title of the form contain HTML? If so, you are responsible for doing any needed escaping/sanitization yourself. Otherwise the title will be run through htmlspecialchars() before being output.

public bool $_encodeTitle = \true

$_firstField

public mixed $_firstField = \null

$_helpMarker

public mixed $_helpMarker = '?'

$_requiredLegend

public mixed $_requiredLegend = \false

$_requiredMarker

public mixed $_requiredMarker = '*'

$_showHeader

public mixed $_showHeader = \true

$_stripedRows

public mixed $_stripedRows = \false

$_varRenderer

public mixed $_varRenderer = \null

Methods

__construct()

public __construct([mixed $params = array() ]) : mixed
Parameters
$params : mixed = array()
Return values
mixed

_listAllFormVars()

public _listAllFormVars() : mixed
Return values
mixed

_renderBeginActive()

Implementation specific begin function.

public _renderBeginActive(mixed $name, mixed $extra) : mixed
Parameters
$name : mixed
$extra : mixed
Return values
mixed

_renderBeginInactive()

Implementation specific begin function.

public _renderBeginInactive(mixed $name, mixed $extra) : mixed
Parameters
$name : mixed
$extra : mixed
Return values
mixed

_renderDescription()

public _renderDescription(mixed $text) : mixed
Parameters
$text : mixed
Return values
mixed

_renderEnd()

Implementation specific end function.

public _renderEnd() : mixed
Return values
mixed

_renderForm()

public _renderForm(mixed &$form, mixed &$vars, mixed $active) : mixed
Parameters
$form : mixed
$vars : mixed
$active : mixed
Return values
mixed

_renderHeader()

public _renderHeader(mixed $header[, mixed $error = '' ]) : mixed
Parameters
$header : mixed
$error : mixed = ''
Return values
mixed

_renderSectionBegin()

public _renderSectionBegin(mixed &$form, mixed $section) : mixed
Parameters
$form : mixed
$section : mixed
Return values
mixed

_renderSectionEnd()

public _renderSectionEnd() : mixed
Return values
mixed

_renderSectionTabs()

public _renderSectionTabs(mixed &$form) : mixed
Parameters
$form : mixed
Return values
mixed

_renderSpacer()

public _renderSpacer() : mixed
Return values
mixed

_renderSubmit()

public _renderSubmit(mixed $submit, mixed $reset) : mixed
Parameters
$submit : mixed
$reset : mixed
Return values
mixed

_renderVarDisplayBegin()

public _renderVarDisplayBegin(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
Return values
mixed

_renderVarDisplayEnd()

public _renderVarDisplayEnd(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
Return values
mixed

_renderVarInputBegin()

public _renderVarInputBegin(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
Return values
mixed

_renderVarInputEnd()

public _renderVarInputEnd(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
Return values
mixed

_sectionHeader()

public _sectionHeader(mixed $title[, mixed $extra = '' ]) : mixed
Parameters
$title : mixed
$extra : mixed = ''
Return values
mixed

beginActive()

public beginActive(mixed $name[, mixed $extra = null ]) : mixed
Parameters
$name : mixed
$extra : mixed = null
Return values
mixed

beginInactive()

public beginInactive(mixed $name[, mixed $extra = null ]) : mixed
Parameters
$name : mixed
$extra : mixed = null
Return values
mixed

close()

public close([mixed $focus = true ]) : mixed
Parameters
$focus : mixed = true
Return values
mixed

encodeTitle()

Sets or returns whether the form title should be encoded with htmlspecialchars().

public encodeTitle([bool $encode = null ]) : bool
Parameters
$encode : bool = null

If true, the form title gets encoded. If false the title can contain HTML, but the class user is responsible to encode any special characters.

Return values
bool

Whether the form title should be encoded.

end()

public end() : mixed
Return values
mixed

factory()

Attempts to return a concrete Horde_Form_Renderer instance based on $renderer.

public factory([mixed $renderer = '' ][, array<string|int, mixed> $params = null ]) : Horde_Form_Renderer
Parameters
$renderer : mixed = ''

The type of concrete Horde_Form_Renderer subclass to return. The code is dynamically included. If $renderer is an array, then we will look in $renderer[0]/lib/Form/Renderer/ for the subclass implementation named $renderer[1].php.

$params : array<string|int, mixed> = null

A hash containing any additional configuration a form might need.

Return values
Horde_Form_Renderer

The concrete Horde_Form_Renderer reference, or false on an error.

getFormVars()

public getFormVars(mixed $form) : mixed
Parameters
$form : mixed
Return values
mixed

Horde_Form_Renderer()

Construct a new Horde_Form_Renderer::.

public static Horde_Form_Renderer([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

This is a hash of renderer-specific parameters. Possible keys:

  • 'varrenderer_driver': specifies the driver parameter to Horde_Core_Ui_VarRenderer::factory().
  • 'encode_title': @see $_encodeTitle
Return values
mixed

listFormVars()

public listFormVars(mixed &$form) : mixed
Parameters
$form : mixed
Return values
mixed

open()

public open(mixed $action, mixed $method, mixed $name[, mixed $enctype = null ]) : mixed
Parameters
$action : mixed
$method : mixed
$name : mixed
$enctype : mixed = null
Return values
mixed

renderFormActive()

public renderFormActive(mixed &$form, mixed &$vars) : mixed
Parameters
$form : mixed
$vars : mixed
Return values
mixed

renderFormInactive()

public renderFormInactive(mixed &$form, mixed &$vars) : mixed
Parameters
$form : mixed
$vars : mixed
Return values
mixed

setAttrColumnWidth()

public setAttrColumnWidth(mixed $width) : mixed
Parameters
$width : mixed
Tags
deprecated
Return values
mixed

showHeader()

public showHeader(mixed $bool) : mixed
Parameters
$bool : mixed
Return values
mixed

singleton()

Attempts to return a reference to a concrete Horde_Form_Renderer instance based on $renderer. It will only create a new instance if no Horde_Form_Renderer instance with the same parameters currently exists.

public & singleton(mixed $renderer[, array<string|int, mixed> $params = null ]) : Horde_Form_Renderer

This should be used if multiple types of form renderers (and, thus, multiple Horde_Form_Renderer instances) are required.

This method must be invoked as: $var = &Horde_Form_Renderer::singleton()

Parameters
$renderer : mixed

The type of concrete Horde_Form_Renderer subclass to return. The code is dynamically included. If $renderer is an array, then we will look in $renderer[0]/lib/Form/Renderer/ for the subclass implementation named $renderer[1].php.

$params : array<string|int, mixed> = null

A hash containing any additional configuration a form might need.

Return values
Horde_Form_Renderer

The concrete Horde_Form_Renderer reference, or false on an error.

submit()

public submit([mixed $submit = null ][, mixed $reset = false ]) : mixed
Parameters
$submit : mixed = null
$reset : mixed = false
Return values
mixed

Search results