Class Horde_Form_Renderer

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

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

Package: Form
Author: Robert E. Coyle robertecoyle@hotmail.com
Located at Horde/Form/Renderer.php

Methods summary
`public`	# `Horde_Form_Renderer( array $params = array() )` Construct a new Horde_Form_Renderer::. Construct a new Horde_Form_Renderer::. Parameters `$params` <p>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</p>
`public`	# `showHeader( mixed $bool )`
`public boolean`	# `encodeTitle( boolean $encode = null )` Sets or returns whether the form title should be encoded with htmlspecialchars(). Sets or returns whether the form title should be encoded with htmlspecialchars(). Parameters `$encode` <p>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.</p> Returns `boolean` Whether the form title should be encoded.
`public`	# `open( mixed $action, mixed $method, mixed $name, mixed $enctype = null )`
`public`	# `beginActive( mixed $name, mixed $extra = null )`
`public`	# `beginInactive( mixed $name, mixed $extra = null )`
`public`	# `_renderSectionTabs( mixed & $form )`
`public`	# `_renderSectionBegin( mixed & $form, mixed $section )`
`public`	# `_renderSectionEnd( )`
`public`	# `end( )`
`public`	# `close( mixed $focus = true )`
`public`	# `listFormVars( mixed & $form )`
`public`	# `renderFormActive( mixed & $form, mixed & $vars )`
`public`	# `renderFormInactive( mixed & $form, mixed & $vars )`
`public`	# `_renderForm( mixed & $form, mixed & $vars, mixed $active )`
`public`	# `submit( mixed $submit = null, mixed $reset = false )`
`public`	# `_renderBeginActive( mixed $name, mixed $extra )` Implementation specific begin function. Implementation specific begin function.
`public`	# `_renderBeginInactive( mixed $name, mixed $extra )` Implementation specific begin function. Implementation specific begin function.
`public`	# `_renderEnd( )` Implementation specific end function. Implementation specific end function.
`public`	# `_renderHeader( mixed $header, mixed $error = '' )`
`public`	# `_renderDescription( mixed $text )`
`public`	# `_renderSpacer( )`
`public`	# `_renderSubmit( mixed $submit, mixed $reset )`
`public`	# `_renderVarInputBegin( mixed & $form, mixed & $var, mixed & $vars )`
`public`	# `_renderVarInputEnd( mixed & $form, mixed & $var, mixed & $vars )`
`public`	# `_renderVarDisplayBegin( mixed & $form, mixed & $var, mixed & $vars )`
`public`	# `_renderVarDisplayEnd( mixed & $form, mixed & $var, mixed & $vars )`
`public`	# `_sectionHeader( mixed $title, mixed $extra = '' )`
`public Horde_Form_Renderer`	# `factory( mixed $renderer = '', array $params = null )` Attempts to return a concrete Horde_Form_Renderer instance based on $renderer. Attempts to return a concrete Horde_Form_Renderer instance based on $renderer. Parameters `$renderer` <p>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.</p> `$params` <p>A hash containing any additional configuration a form might need.</p> Returns `Horde_Form_Renderer` The concrete Horde_Form_Renderer reference, or false on an error.
`public Horde_Form_Renderer &`	# `singleton( mixed $renderer, array $params = null )` 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. 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 `$renderer` <p>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.</p> `$params` <p>A hash containing any additional configuration a form might need.</p> Returns `Horde_Form_Renderer` The concrete Horde_Form_Renderer reference, or false on an error.

Properties summary
`public mixed`	`$_name`	#
`public boolean`	`$_requiredLegend`	# `false`
`public string`	`$_requiredMarker`	# `'*'`
`public string`	`$_helpMarker`	# `'?'`
`public boolean`	`$_showHeader`	# `true`
`public integer`	`$_cols`	# `2`
`public mixed`	`$_varRenderer`	# `null`
`public mixed`	`$_firstField`	# `null`
`public boolean`	`$_stripedRows`	# `true`
`public boolean`	`$_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. 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.	# `true`
`public string`	`$_attrColumnWidth` Width of the attributes column. Width of the attributes column.	# `'15%'`

Packages

Classes

Class Horde_Form_Renderer

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns