Properties

$_name

$_name : 

Type

$_requiredLegend

$_requiredLegend : 

Type

$_requiredMarker

$_requiredMarker : 

Type

$_helpMarker

$_helpMarker : 

Type

$_showHeader

$_showHeader : 

Type

$_cols

$_cols : 

Type

$_varRenderer

$_varRenderer : 

Type

$_firstField

$_firstField : 

Type

$_stripedRows

$_stripedRows : 

Type

$_forms

$_forms : 

Type

$_encodeTitle

$_encodeTitle : boolean

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.

Type

boolean

$_attrColumnWidth

$_attrColumnWidth : string

Width of the attributes column.

Type

string

Methods

Horde_Form_Renderer()

Horde_Form_Renderer(array  $params = array()) 

Construct a new Horde_Form_Renderer::.

Parameters

array $params

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

showHeader()

showHeader(  $bool) 

Parameters

$bool

encodeTitle()

encodeTitle(boolean  $encode = null) : boolean

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

Parameters

boolean $encode

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.

Returns

boolean —

Whether the form title should be encoded.

setAttrColumnWidth()

setAttrColumnWidth(  $width) 

Parameters

$width

open()

open(  $action,   $method,   $name,   $enctype = null) 

Parameters

$action
$method
$name
$enctype

beginActive()

beginActive(  $name,   $extra = null) 

Parameters

$name
$extra

beginInactive()

beginInactive(  $name,   $extra = null) 

Parameters

$name
$extra

_renderSectionTabs()

_renderSectionTabs(  $form) 

Parameters

$form

_renderSectionBegin()

_renderSectionBegin(  $form,   $section) 

Parameters

$form
$section

_renderSectionEnd()

_renderSectionEnd() 

end()

end() 

close()

close(  $focus = true) 

Parameters

$focus

getFormVars()

getFormVars(  $form) 

Parameters

$form

listFormVars()

listFormVars(  $form) 

Parameters

$form

_listAllFormVars()

_listAllFormVars() 

renderFormActive()

renderFormActive(  $form,   $vars) 

Parameters

$form
$vars

renderFormInactive()

renderFormInactive(  $form,   $vars) 

Parameters

$form
$vars

_renderForm()

_renderForm(  $form,   $vars,   $active) 

Parameters

$form
$vars
$active

submit()

submit(  $submit = null,   $reset = false) 

Parameters

$submit
$reset

_renderBeginActive()

_renderBeginActive(  $name,   $extra) 

Implementation specific begin function.

Parameters

$name
$extra

_renderBeginInactive()

_renderBeginInactive(  $name,   $extra) 

Implementation specific begin function.

Parameters

$name
$extra

_renderEnd()

_renderEnd() 

Implementation specific end function.

_renderHeader()

_renderHeader(  $header,   $error = '') 

Parameters

$header
$error

_renderDescription()

_renderDescription(  $text) 

Parameters

$text

_renderSpacer()

_renderSpacer() 

_renderSubmit()

_renderSubmit(  $submit,   $reset) 

Parameters

$submit
$reset

_renderVarInputBegin()

_renderVarInputBegin(  $form,   $var,   $vars) 

Parameters

$form
$var
$vars

_renderVarInputEnd()

_renderVarInputEnd(  $form,   $var,   $vars) 

Parameters

$form
$var
$vars

_renderVarDisplayBegin()

_renderVarDisplayBegin(  $form,   $var,   $vars) 

Parameters

$form
$var
$vars

_renderVarDisplayEnd()

_renderVarDisplayEnd(  $form,   $var,   $vars) 

Parameters

$form
$var
$vars

_sectionHeader()

_sectionHeader(  $title,   $extra = '') 

Parameters

$title
$extra

factory()

factory(mixed  $renderer = '', array  $params = null) : \Horde_Form_Renderer

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

Parameters

mixed $renderer

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.

array $params

A hash containing any additional configuration a form might need.

Returns

\Horde_Form_Renderer

The concrete Horde_Form_Renderer reference, or false on an error.

singleton()

singleton(mixed  $renderer, array  $params = null) : \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.

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

mixed $renderer

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.

array $params

A hash containing any additional configuration a form might need.

Returns

\Horde_Form_Renderer

The concrete Horde_Form_Renderer reference, or false on an error.