Documentation

Horde_Core_Form_Renderer_Html extends 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.

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
$_enctype  : mixed
$_reset  : mixed
$_submit  : mixed
__construct()  : mixed
Construct a new Horde_Form_Renderer::.
_preserveVarByPost()  : mixed
_renderBeginActive()  : mixed
Implementation specific begin function.
_renderBeginInactive()  : mixed
Implementation specific begin function.
_renderDescription()  : mixed
_renderForm()  : mixed
_renderHeader()  : mixed
_renderSectionHeader()  : mixed
Renders the header for the section.
_renderSpacer()  : mixed
_renderSubmit()  : mixed
_renderVarDisplayBegin()  : mixed
Renders the beginning of a readonly form entry.
_renderVarDisplayEnd()  : mixed
Renders the end of a readonly form entry. Help and notes are not applicable.
_renderVarInputBegin()  : mixed
Renders the beginning of an writeable form entry, including the label and any form error related to this variable.
_renderVarInputEnd()  : mixed
Renders the end of an writeable form entry, including any form notes and help info.
addButtons()  : mixed
encodeTitle()  : bool
Sets or returns whether the form title should be encoded with htmlspecialchars().
listFormVars()  : mixed
preserveVarByPost()  : mixed
renderActive()  : mixed
renderInactive()  : mixed
setButtons()  : mixed
showHeader()  : mixed
submit()  : mixed
_renderSectionBegin()  : mixed
_renderSectionEnd()  : mixed
_renderSectionTabs()  : 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

$_enctype

protected mixed $_enctype = 'multipart/form-data'

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

_preserveVarByPost()

public _preserveVarByPost(mixed $varname, mixed $value) : mixed
Parameters
$varname : mixed
$value : mixed
Return values
mixed

_renderBeginActive()

Implementation specific begin function.

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

_renderBeginInactive()

Implementation specific begin function.

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

_renderDescription()

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

_renderForm()

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

_renderHeader()

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

_renderSectionHeader()

Renders the header for the section.

public _renderSectionHeader(string $title) : mixed
Parameters
$title : string

section header title

Tags
access

private

author

Matt Warden mwarden@gmail.com

author

Robert E. Coyle robertecoyle@hotmail.com

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

Renders the beginning of a readonly form entry.

public _renderVarDisplayBegin(mixed $form, mixed $var) : mixed
Parameters
$form : mixed
$var : mixed
Tags
access

private

author

Matt Warden mwarden@gmail.com

author

Robert E. Coyle robertecoyle@hotmail.com

Return values
mixed

_renderVarDisplayEnd()

Renders the end of a readonly form entry. Help and notes are not applicable.

public _renderVarDisplayEnd() : mixed
Tags
access

private

author

Matt Warden mwarden@gmail.com

author

Robert E. Coyle robertecoyle@hotmail.com

Return values
mixed

_renderVarInputBegin()

Renders the beginning of an writeable form entry, including the label and any form error related to this variable.

public _renderVarInputBegin(mixed $form, mixed $var[, mixed $readonly = false ]) : mixed
Parameters
$form : mixed
$var : mixed
$readonly : mixed = false
Tags
access

private

author

Matt Warden mwarden@gmail.com

author

Robert E. Coyle robertecoyle@hotmail.com

Return values
mixed

_renderVarInputEnd()

Renders the end of an writeable form entry, including any form notes and help info.

public _renderVarInputEnd(mixed $form, mixed $var) : mixed
Parameters
$form : mixed
$var : mixed
Tags
access

private

author

Matt Warden mwarden@gmail.com

author

Robert E. Coyle robertecoyle@hotmail.com

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.

listFormVars()

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

preserveVarByPost()

public preserveVarByPost(mixed $vars, mixed $varname[, mixed $alt_varname = '' ]) : mixed
Parameters
$vars : mixed
$varname : mixed
$alt_varname : mixed = ''
Return values
mixed

renderActive()

public 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

renderInactive()

public renderInactive(mixed $form) : mixed
Parameters
$form : mixed
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

submit()

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

_renderSectionBegin()

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

_renderSectionEnd()

protected _renderSectionEnd() : mixed
Return values
mixed

_renderSectionTabs()

protected _renderSectionTabs(mixed $form) : mixed
Parameters
$form : mixed
Return values
mixed

Search results