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