Class Horde_Form_Renderer

Description

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

$Horde: framework/Form/Form/Renderer.php,v 1.185.4.22 2008/06/15 21:12:17 chuck Exp $

Copyright 2001-2007 Robert E. Coyle <robertecoyle@hotmail.com>

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Form/Form/Renderer.php (line 16)


	
			
Variable Summary
Method Summary
 Horde_Form_Renderer Horde_Form_Renderer ([array $params = array()])
 void beginActive ( $name, [ $extra = null])
 void beginInactive ( $name, [ $extra = null])
 void close ([ $focus = true])
 boolean encodeTitle ([boolean $encode = null])
 void end ()
 Horde_Form_Renderer factory ([mixed $renderer = ''], [array $params = null])
 void listFormVars ( &$form)
 void open ( $action,  $method,  $name, [ $enctype = null])
 void renderFormActive ( &$form,  &$vars)
 void renderFormInactive ( &$form,  &$vars)
 void setAttrColumnWidth ( $width)
 void showHeader ( $bool)
 Horde_Form_Renderer &singleton (mixed $renderer, [array $params = null])
 void submit ([ $submit = null], [ $reset = false])
 void _renderBeginActive ( $name,  $extra)
 void _renderBeginInactive ( $name,  $extra)
 void _renderDescription ( $text)
 void _renderEnd ()
 void _renderForm ( &$form,  &$vars,  $active)
 void _renderHeader ( $header, [ $error = ''])
 void _renderSectionBegin ( &$form,  $section)
 void _renderSectionTabs ( &$form)
 void _renderSpacer ()
 void _renderSubmit ( $submit,  $reset)
 void _renderVarDisplayBegin ( &$form,  &$var,  &$vars)
 void _renderVarDisplayEnd ( &$form,  &$var,  &$vars)
 void _renderVarInputBegin ( &$form,  &$var,  &$vars)
 void _renderVarInputEnd ( &$form,  &$var,  &$vars)
 void _sectionHeader ( $title, [ $extra = ''])
Variables
mixed $_cols = 2 (line 23)
boolean $_encodeTitle = true (line 35)

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.

mixed $_firstField = null (line 25)
mixed $_helpMarker = '?' (line 21)
mixed $_name (line 18)
mixed $_requiredLegend = false (line 19)
mixed $_requiredMarker = '*' (line 20)
mixed $_showHeader = true (line 22)
mixed $_stripedRows = true (line 26)
mixed $_varRenderer = null (line 24)
Methods
Constructor Horde_Form_Renderer (line 54)

Construct a new Horde_Form_Renderer::.

Horde_Form_Renderer Horde_Form_Renderer ([array $params = array()])
  • array $params: This is a hash of renderer-specific parameters. Possible keys:
    1.                        'varrenderer_driver'specifies the driver
    2.                            parameter to Horde_UI_VarRenderer::factory().
    3.                        'encode_title'@see $_encodeTitle
beginActive (line 117)
void beginActive ( $name, [ $extra = null])
  • $name
  • $extra
beginInactive (line 122)
void beginInactive ( $name, [ $extra = null])
  • $name
  • $extra
close (line 189)
void close ([ $focus = true])
  • $focus
encodeTitle (line 92)

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

  • return: Whether the form title should be encoded.
boolean encodeTitle ([boolean $encode = null])
  • 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.
end (line 184)
void end ()
factory (line 478)

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

  • return: The concrete Horde_Form_Renderer reference, or false on an error.
Horde_Form_Renderer factory ([mixed $renderer = ''], [array $params = null])
  • 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.
listFormVars (line 204)
void listFormVars ( &$form)
  • &$form
open (line 107)
void open ( $action,  $method,  $name, [ $enctype = null])
  • $action
  • $method
  • $name
  • $enctype
renderFormActive (line 223)
void renderFormActive ( &$form,  &$vars)
  • &$form
  • &$vars
renderFormInactive (line 228)
void renderFormInactive ( &$form,  &$vars)
  • &$form
  • &$vars
setAttrColumnWidth (line 103)
  • deprecated:
void setAttrColumnWidth ( $width)
  • $width
showHeader (line 77)
void showHeader ( $bool)
  • $bool
singleton (line 530)

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

  • return: The concrete Horde_Form_Renderer reference, or false on an error.
Horde_Form_Renderer &singleton (mixed $renderer, [array $params = null])
  • 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.
submit (line 312)
void submit ([ $submit = null], [ $reset = false])
  • $submit
  • $reset
_renderBeginActive (line 326)

Implementation specific begin function.

void _renderBeginActive ( $name,  $extra)
  • $name
  • $extra
_renderBeginInactive (line 340)

Implementation specific begin function.

void _renderBeginInactive ( $name,  $extra)
  • $name
  • $extra
_renderDescription (line 366)
void _renderDescription ( $text)
  • $text
_renderEnd (line 351)

Implementation specific end function.

void _renderEnd ()
_renderForm (line 233)
void _renderForm ( &$form,  &$vars,  $active)
  • &$form
  • &$vars
  • $active
_renderHeader (line 356)
void _renderHeader ( $header, [ $error = ''])
  • $header
  • $error
_renderSectionBegin (line 159)
void _renderSectionBegin ( &$form,  $section)
  • &$form
  • $section
_renderSectionEnd (line 179)
void _renderSectionEnd ()
_renderSectionTabs (line 127)
void _renderSectionTabs ( &$form)
  • &$form
_renderSpacer (line 372)
void _renderSpacer ()
_renderSubmit (line 378)
void _renderSubmit ( $submit,  $reset)
  • $submit
  • $reset
_renderVarDisplayBegin (line 430)
void _renderVarDisplayBegin ( &$form,  &$var,  &$vars)
  • &$form
  • &$var
  • &$vars
_renderVarDisplayEnd (line 443)
void _renderVarDisplayEnd ( &$form,  &$var,  &$vars)
  • &$form
  • &$var
  • &$vars
_renderVarInputBegin (line 392)
void _renderVarInputBegin ( &$form,  &$var,  &$vars)
  • &$form
  • &$var
  • &$vars
_renderVarInputEnd (line 408)
void _renderVarInputEnd ( &$form,  &$var,  &$vars)
  • &$form
  • &$var
  • &$vars
_sectionHeader (line 451)
void _sectionHeader ( $title, [ $extra = ''])
  • $title
  • $extra

Documentation generated on Sun, 30 Jan 2011 05:20:52 +0000 by phpDocumentor 1.4.3