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