PHP Class Horde_Form, horde

The Horde_Form:: package provides form rendering, validation, and other functionality for the Horde Application Framework. Copyright 2001-2007 Robert E. Coyle Copyright 2001-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Robert E. Coyle ([email protected])
Author: Chuck Hagenbuch ([email protected])
Mostra file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$_help
$_sections

Protected Properties

Property Type Description
$_autofilled
$_currentSection
$_enctype
$_errors
$_extra
$_hiddenVariables
$_name
$_open_section
$_reset
$_submit
$_submitted
$_title
$_useFormToken
$_variables
$_vars

Public Methods

Method Description
__construct ( $vars, $title = '', $name = null )
_getInfoFromVariables ( array $variables, object &$vars, array &$info ) Fetch the field values from a given array of variables.
_preserveVarByPost ( $varname, $value )
addHidden ( $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] ) TODO
addVariable ( $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] ) TODO
appendButtons ( $submit )
clearError ( $var )
clearValidation ( )
close ( $renderer )
execute ( )
getError ( $var )
getErrors ( )
getExtra ( )
getInfo ( Variables $vars, array &$info ) Fetch the field values of the submitted form.
getName ( )
getOpenSection ( )
getRenderer ( array $params = [] ) : object Get the renderer for this form, either a custom renderer or the standard one.
getSectionDesc ( $section )
getSectionExpandedState ( $section, $boolean = false )
getSectionImage ( $section )
getTitle ( )
getType ( $type, $params = [] )
getVariables ( $flat = true, $withHidden = false )
getVars ( )
hasHelp ( )
insertVariableBefore ( $before, $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] ) TODO
isSubmitted ( ) : boolean Determines if this form has been submitted or not. If the class var _submitted is null then it will check for the presence of the formname in the form variables.
isValid ( )
onSubmit ( Horde_Variables &$vars ) Checks if there is anything to do on the submission of the form by looping through each variable's onSubmit() function.
open ( &$renderer, &$vars, $action, $method = 'get', $enctype = null )
preserve ( $vars )
preserveVarByPost ( &$vars, $varname, $alt_varname = '' )
removeVariable ( Horde_Form_Variable | string &$var ) : boolean Removes a variable from the form.
renderActive ( Horde_Form_Renderer $renderer = null, Variables $vars = null, string $action = '', string $method = 'get', string $enctype = null, boolean $focus = true ) Renders the form for editing.
renderInactive ( Horde_Form_Renderer $renderer = null, Variables $vars = null ) Renders the form for displaying.
setButtons ( $submit, $reset = false )
setError ( $var, $message )
setExtra ( $extra )
setOpenSection ( $section )
setSection ( $section = '', $desc = '', $image = '', $expanded = true )
setSubmitted ( boolean $state = true ) Explicitly sets the state of the form submit.
setTitle ( $title )
setVars ( &$vars )
singleton ( $form, &$vars, $title = '', $name = null )
unsetVars ( &$vars )
useToken ( boolean $token = null ) : boolean Sets or gets whether the form should be verified by tokens.
validate ( Variables $vars = null, $canAutoFill = false ) : boolean Validates the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for variable types in the form. The _submitted variable is then rechecked.

Method Details

__construct() public method

public __construct ( $vars, $title = '', $name = null )

_getInfoFromVariables() public method

Fetch the field values from a given array of variables.
public _getInfoFromVariables ( array $variables, object &$vars, array &$info )
$variables array An array of Horde_Form_Variable objects to fetch from.
$vars object The Variables object.
$info array The array to be filled with the submitted field values.

_preserveVarByPost() public method

public _preserveVarByPost ( $varname, $value )

addHidden() public method

TODO
public addHidden ( $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] )

addVariable() public method

TODO
public addVariable ( $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] )

appendButtons() public method

public appendButtons ( $submit )

clearError() public method

public clearError ( $var )

clearValidation() public method

public clearValidation ( )

close() public method

public close ( $renderer )

execute() public method

public execute ( )

getError() public method

public getError ( $var )

getErrors() public method

public getErrors ( )

getExtra() public method

public getExtra ( )

getInfo() public method

Fetch the field values of the submitted form.
public getInfo ( Variables $vars, array &$info )
$vars Variables A Variables instance, optional since Horde 3.2.
$info array Array to be filled with the submitted field values.

getName() public method

public getName ( )

getOpenSection() public method

public getOpenSection ( )

getRenderer() public method

To use a custom form renderer, your form class needs to override this function: function getRenderer() { return new CustomFormRenderer(); } ... where CustomFormRenderer is the classname of the custom renderer class, which should extend Horde_Form_Renderer.
public getRenderer ( array $params = [] ) : object
$params array A hash of renderer-specific parameters.
return object Horde_Form_Renderer The form renderer.

getSectionDesc() public method

public getSectionDesc ( $section )

getSectionExpandedState() public method

public getSectionExpandedState ( $section, $boolean = false )

getSectionImage() public method

public getSectionImage ( $section )

getTitle() public method

public getTitle ( )

getType() public method

public getType ( $type, $params = [] )

getVariables() public method

public getVariables ( $flat = true, $withHidden = false )

getVars() public method

public getVars ( )

hasHelp() public method

public hasHelp ( )

insertVariableBefore() public method

TODO
public insertVariableBefore ( $before, $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] )

isSubmitted() public method

Other events can explicitly set the _submitted variable to false to indicate a form submit but not for actual posting of data (eg. onChange events to update the display of fields).
public isSubmitted ( ) : boolean
return boolean True or false indicating if the form has been submitted.

isValid() public method

public isValid ( )

onSubmit() public method

Checks if there is anything to do on the submission of the form by looping through each variable's onSubmit() function.
public onSubmit ( Horde_Variables &$vars )
$vars Horde_Variables

open() public method

public open ( &$renderer, &$vars, $action, $method = 'get', $enctype = null )

preserve() public method

public preserve ( $vars )

preserveVarByPost() public method

public preserveVarByPost ( &$vars, $varname, $alt_varname = '' )

removeVariable() public method

As only variables can be passed by reference, you need to call this method this way if want to pass a variable name: $form->removeVariable($var = 'varname');
public removeVariable ( Horde_Form_Variable | string &$var ) : boolean
$var Horde_Form_Variable | string Either the variable's name or the variable to remove from the form.
return boolean True if the variable was found (and deleted).

renderActive() public method

Renders the form for editing.
public renderActive ( Horde_Form_Renderer $renderer = null, Variables $vars = null, string $action = '', string $method = 'get', string $enctype = null, boolean $focus = true )
$renderer Horde_Form_Renderer A renderer instance, optional since Horde 3.2.
$vars Variables A Variables instance, optional since Horde 3.2.
$action string The form action (url).
$method string The form method, usually either 'get' or 'post'.
$enctype string The form encoding type. Determined automatically if null.
$focus boolean Focus the first form field?

renderInactive() public method

Renders the form for displaying.
public renderInactive ( Horde_Form_Renderer $renderer = null, Variables $vars = null )
$renderer Horde_Form_Renderer A renderer instance, optional since Horde 3.2.
$vars Variables A Variables instance, optional since Horde 3.2.

setButtons() public method

public setButtons ( $submit, $reset = false )

setError() public method

public setError ( $var, $message )

setExtra() public method

public setExtra ( $extra )

setOpenSection() public method

public setOpenSection ( $section )

setSection() public method

public setSection ( $section = '', $desc = '', $image = '', $expanded = true )

setSubmitted() public method

An event can override the automatic determination of the submit state in the isSubmitted() function.
public setSubmitted ( boolean $state = true )
$state boolean Whether to set the state of the form as being submitted.

setTitle() public method

public setTitle ( $title )

setVars() public method

public setVars ( &$vars )

singleton() public method

public singleton ( $form, &$vars, $title = '', $name = null )

unsetVars() public method

public unsetVars ( &$vars )

useToken() public method

Tokens are used to verify that a form is only submitted once.
public useToken ( boolean $token = null ) : boolean
$token boolean If specified, sets whether to use form tokens.
return boolean Whether form tokens are being used.

validate() public method

Validates the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for variable types in the form. The _submitted variable is then rechecked.
public validate ( Variables $vars = null, $canAutoFill = false ) : boolean
$vars Variables A Variables instance, optional since Horde 3.2.
return boolean True if the form is valid.

Property Details

$_autofilled protected_oe property

protected $_autofilled

$_currentSection protected_oe property

protected $_currentSection

$_enctype protected_oe property

protected $_enctype

$_errors protected_oe property

protected $_errors

$_extra protected_oe property

protected $_extra

$_help public_oe property

public $_help

$_hiddenVariables protected_oe property

protected $_hiddenVariables

$_name protected_oe property

protected $_name

$_open_section protected_oe property

protected $_open_section

$_reset protected_oe property

protected $_reset

$_sections public_oe property

public $_sections

$_submit protected_oe property

protected $_submit

$_submitted protected_oe property

protected $_submitted

$_title protected_oe property

protected $_title

$_useFormToken protected_oe property

protected $_useFormToken

$_variables protected_oe property

protected $_variables

$_vars protected_oe property

protected $_vars