Documentation

Horde_Core_Form_Renderer
in package

The Horde_Core_Form_Renderer class provides HTML and other renderings of forms for the Horde_Core_Form package.

Copyright 2001-2007 Robert E. Coyle robertecoyle@hotmail.com Copyright 2005-2007 Matt Warden mwarden@gmail.com

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
author

Robert E. Coyle robertecoyle@hotmail.com

author

Matt Warden mwarden@gmail.com

Table of Contents

$_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
$_helpMarker  : mixed
$_name  : mixed
$_onLoadJS  : mixed
$_requiredLegend  : mixed
$_showHeader  : mixed
$_stripedRows  : mixed
$_reset  : mixed
$_submit  : mixed
__construct()  : mixed
Construct a new Horde_Form_Renderer::.
addButtons()  : mixed
encodeTitle()  : bool
Sets or returns whether the form title should be encoded with htmlspecialchars().
renderActive()  : mixed
setButtons()  : mixed
showHeader()  : mixed

Properties

$_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 = rue

$_firstField

public mixed $_firstField = ull

$_helpMarker

public mixed $_helpMarker = '?'

$_onLoadJS

public mixed $_onLoadJS = array()

$_requiredLegend

public mixed $_requiredLegend = alse

$_showHeader

public mixed $_showHeader = rue

$_stripedRows

public mixed $_stripedRows = rue

$_submit

protected mixed $_submit = array()

Methods

__construct()

Construct a new Horde_Form_Renderer::.

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

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

  • 'encode_title': @see $_encodeTitle
Return values
mixed —

addButtons()

public addButtons(mixed $buttons) : mixed
Parameters
$buttons : mixed
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.

renderActive()

public abstract renderActive(mixed $form, mixed $action[, mixed $method = 'get' ][, mixed $enctype = null ][, mixed $focus = true ]) : mixed
Parameters
$form : mixed
$action : mixed
$method : mixed = 'get'
$enctype : mixed = null
$focus : mixed = true
Return values
mixed —

setButtons()

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

showHeader()

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

Search results