PHP Класс 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.
Автор: Robert E. Coyle ([email protected])
Автор: Chuck Hagenbuch ([email protected])
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$_help
$_sections

Защищенные свойства (Protected)

Свойство Тип Описание
$_autofilled
$_currentSection
$_enctype
$_errors
$_extra
$_hiddenVariables
$_name
$_open_section
$_reset
$_submit
$_submitted
$_title
$_useFormToken
$_variables
$_vars

Открытые методы

Метод Описание
__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.

Описание методов

__construct() публичный Метод

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

_getInfoFromVariables() публичный Метод

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 _preserveVarByPost ( $varname, $value )

addHidden() публичный Метод

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

addVariable() публичный Метод

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

appendButtons() публичный Метод

public appendButtons ( $submit )

clearError() публичный Метод

public clearError ( $var )

clearValidation() публичный Метод

public clearValidation ( )

close() публичный Метод

public close ( $renderer )

execute() публичный Метод

public execute ( )

getError() публичный Метод

public getError ( $var )

getErrors() публичный Метод

public getErrors ( )

getExtra() публичный Метод

public getExtra ( )

getInfo() публичный Метод

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

getOpenSection() публичный Метод

public getOpenSection ( )

getRenderer() публичный Метод

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.
Результат object Horde_Form_Renderer The form renderer.

getSectionDesc() публичный Метод

public getSectionDesc ( $section )

getSectionExpandedState() публичный Метод

public getSectionExpandedState ( $section, $boolean = false )

getSectionImage() публичный Метод

public getSectionImage ( $section )

getTitle() публичный Метод

public getTitle ( )

getType() публичный Метод

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

getVariables() публичный Метод

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

getVars() публичный Метод

public getVars ( )

hasHelp() публичный Метод

public hasHelp ( )

insertVariableBefore() публичный Метод

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

isSubmitted() публичный Метод

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
Результат boolean True or false indicating if the form has been submitted.

isValid() публичный Метод

public isValid ( )

onSubmit() публичный Метод

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 open ( &$renderer, &$vars, $action, $method = 'get', $enctype = null )

preserve() публичный Метод

public preserve ( $vars )

preserveVarByPost() публичный Метод

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

removeVariable() публичный Метод

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.
Результат boolean True if the variable was found (and deleted).

renderActive() публичный Метод

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() публичный Метод

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 setButtons ( $submit, $reset = false )

setError() публичный Метод

public setError ( $var, $message )

setExtra() публичный Метод

public setExtra ( $extra )

setOpenSection() публичный Метод

public setOpenSection ( $section )

setSection() публичный Метод

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

setSubmitted() публичный Метод

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 setTitle ( $title )

setVars() публичный Метод

public setVars ( &$vars )

singleton() публичный Метод

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

unsetVars() публичный Метод

public unsetVars ( &$vars )

useToken() публичный Метод

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.
Результат boolean Whether form tokens are being used.

validate() публичный Метод

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.
Результат boolean True if the form is valid.

Описание свойств

$_autofilled защищенное свойство

protected $_autofilled

$_currentSection защищенное свойство

protected $_currentSection

$_enctype защищенное свойство

protected $_enctype

$_errors защищенное свойство

protected $_errors

$_extra защищенное свойство

protected $_extra

$_help публичное свойство

public $_help

$_hiddenVariables защищенное свойство

protected $_hiddenVariables

$_name защищенное свойство

protected $_name

$_open_section защищенное свойство

protected $_open_section

$_reset защищенное свойство

protected $_reset

$_sections публичное свойство

public $_sections

$_submit защищенное свойство

protected $_submit

$_submitted защищенное свойство

protected $_submitted

$_title защищенное свойство

protected $_title

$_useFormToken защищенное свойство

protected $_useFormToken

$_variables защищенное свойство

protected $_variables

$_vars защищенное свойство

protected $_vars