• Accueil
• Horde_Core_Form

PHP Class Horde_Core_Form, horde

The Horde_Core_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])

Afficher le fichier Open project: horde/horde Class Usage Examples

Protected Properties

Свойство	Type	Description
$_autofilled
$_currentSection
$_errors
$_help
$_hiddenVariables
$_name
$_open_section
$_sections
$_submitted
$_title
$_useFormToken
$_variables
$_vars

Méthodes publiques

Méthode	Description
__construct ( $vars, $title = '', $name = null )
add ( $varName, $type, $humanName, $required, $readonly = false, $description = null, $params = [] )
addHidden ( $varName, $type, $required, $params = [] )	TODO
addVariable ( $humanName, $varName, $type, $required, $readonly = false, $description = null, $params = [] )	TODO
clearError ( $var )
clearValidation ( )
execute ( )
getError ( $var )
getHiddenVariables ( )
getInfo ( 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 )
getSections ( )
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 ( )	Checks if there is anything to do on the submission of the form by looping through each variable's onSubmit() function.
preserve ( Horde_Core_Form $form )	Preserve the variables/values from another Horde_Core_Form object.
removeVariable ( Horde_Core_Form_Variable | string &$var ) : boolean	Removes a variable from the form.
setError ( $var, $message )
setOpenSection ( $section )
setSection ( $section = '', $desc = '', $image = '', $expanded = true )
setSubmitted ( boolean $state = true )	Explicitly sets the state of the form submit.
setTitle ( $title )
setVars ( $vars )
useToken ( boolean $token = null ) : boolean	Sets or gets whether the form should be verified by tokens.
validate ( $canAutoFill = false ) : boolean	Does the action of validating the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for var types in the form. The _submitted var is then rechecked.

Méthodes protégées

Méthode	Description
_getInfoFromVariables ( array $variables, array &$info )	Fetch the field values from a given array of variables.

Method Details

__construct() public méthode

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

_getInfoFromVariables() protected méthode

Fetch the field values from a given array of variables.

protected _getInfoFromVariables ( array $variables, array &$info )
$variables	array	An array of Horde_Core_Form_Variable objects to fetch from.
$info	array	The array to be filled with the submitted field values.

add() public méthode

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

addHidden() public méthode

TODO

public addHidden ( $varName, $type, $required, $params = [] )

addVariable() public méthode

TODO

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

clearError() public méthode

public clearError ( $var )

clearValidation() public méthode

public clearValidation ( )

execute() public méthode

public execute ( )

getError() public méthode

public getError ( $var )

getHiddenVariables() public méthode

public getHiddenVariables ( )

getInfo() public méthode

Fetch the field values of the submitted form.

public getInfo ( array &$info )
$info	array	Array to be filled with the submitted field values.

getName() public méthode

public getName ( )

getOpenSection() public méthode

public getOpenSection ( )

getRenderer() public méthode

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_Core_Form_Renderer.

public getRenderer ( array $params = [] ) : object
$params	array	A hash of renderer-specific parameters.
Résultat	object	Horde_Core_Form_Renderer The form renderer.

getSectionDesc() public méthode

public getSectionDesc ( $section )

getSectionExpandedState() public méthode

public getSectionExpandedState ( $section, $boolean = false )

getSectionImage() public méthode

public getSectionImage ( $section )

getSections() public méthode

public getSections ( )

getTitle() public méthode

public getTitle ( )

getType() public méthode

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

getVariables() public méthode

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

getVars() public méthode

public getVars ( )

hasHelp() public méthode

public hasHelp ( )

insertVariableBefore() public méthode

TODO

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

isSubmitted() public méthode

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
Résultat	boolean	True or false indicating if the form has been submitted.

isValid() public méthode

public isValid ( )

onSubmit() public méthode

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

public onSubmit ( )

preserve() public méthode

Preserve the variables/values from another Horde_Core_Form object.

public preserve ( Horde_Core_Form $form )
$form	Horde_Core_Form

removeVariable() public méthode

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_Core_Form_Variable | string &$var ) : boolean
$var	Horde_Core_Form_Variable | string	Either the variable's name or the variable to remove from the form.
Résultat	boolean	True if the variable was found (and deleted).

setError() public méthode

public setError ( $var, $message )

setOpenSection() public méthode

public setOpenSection ( $section )

setSection() public méthode

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

setSubmitted() public méthode

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 méthode

public setTitle ( $title )

setVars() public méthode

public setVars ( $vars )

useToken() public méthode

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.
Résultat	boolean	Whether form tokens are being used.

validate() public méthode

Does the action of validating the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for var types in the form. The _submitted var is then rechecked.

public validate ( $canAutoFill = false ) : boolean
Résultat	boolean	True if the form is valid.

Property Details

$_autofilled protected_oe property

protected $_autofilled

$_currentSection protected_oe property

protected $_currentSection

$_errors protected_oe property

protected $_errors

$_help protected_oe property

protected $_help

$_hiddenVariables protected_oe property

protected $_hiddenVariables

$_name protected_oe property

protected $_name

$_open_section protected_oe property

protected $_open_section

$_sections protected_oe property

protected $_sections

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