• Accueil
• Horde_Form_Variable

PHP Class Horde_Form_Variable, horde

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

Méthodes publiques

Свойство	Type	Description
$_action	Horde_Form_Action	A {@link Horde_Form_Action} instance.
$_arrayVal	boolean	Whether this is an array variable.
$_autofilled	boolean	TODO
$_defValue	mixed	The default value.
$_disabled	boolean	Whether this variable is disabled.
$_hidden	boolean	Whether this is a hidden variable.
$_options	array	TODO
$description	string	A long description of the variable's purpose, special instructions, etc.
$form	Horde_Form	The form instance this variable is assigned to.
$help	string	The variable help text.
$humanName	string	A short description of this variable's purpose.
$readonly	boolean	Whether this is a readonly variable.
$required	boolean	Whether this is a required variable.
$type	Horde_Form_Type	A {@link Horde_Form_Type} instance.
$varName	string	The internally used name.

Méthodes publiques

Méthode	Description
Horde_Form_Variable ( string $humanName, string $varName, Horde_Form_Type &$type, boolean $required, boolean $readonly = false, string $description = null )	Variable constructor.
disable ( )	Disables this variable.
getDefault ( ) : mixed	Returns this variable's default value.
getDescription ( ) : string	Returns this variable's long description.
getHelp ( ) : string	Returns the help text of this variable.
getHumanName ( ) : string	Return the short description of this variable.
getInfo ( Variables &$vars, mixed &$info ) : mixed	Processes the submitted value of this variable according to the rules of the variable type.
getOption ( string $option ) : mixed	Returns a variable option's value.
getType ( ) : Horde_Form_Type	Returns this variable's type.
getTypeName ( ) : string	Returns the name of this variable's type.
getValue ( Variables &$vars, integer $index = null ) : mixed	Returns the submitted or default value of this variable.
getValues ( ) : array	Returns the possible values of this variable.
getVarName ( ) : string	Returns the internally used variable name.
hasAction ( ) : boolean	Returns whether this variable has an attached action.
hasDescription ( ) : boolean	Returns whether this variable has a long description.
hasHelp ( ) : boolean	Returns whether this variable has some help text assigned.
hide ( )	Makes this a hidden variable.
isArrayVal ( ) : boolean	Returns whether this is an array variable.
isDisabled ( ) : boolean	Returns whether this variable is disabled.
isHidden ( ) : boolean	Returns whether this is a hidden variable.
isReadonly ( ) : boolean	Returns whether this is a readonly variable.
isRequired ( ) : boolean	Returns whether this is a required variable.
isUpload ( ) : boolean	Returns whether this variable is to upload a file.
setAction ( Horde_Form_Action $action )	Assigns an action to this variable.
setDefault ( mixed $value )	Sets a default value for this variable.
setFormOb ( Horde_Form &$form )	Assign this variable to the specified form.
setHelp ( string $help )	Assigns a help text to this variable.
setOption ( string $option, mixed $val )	Sets a variable option.
validate ( Variables &$vars, string &$message ) : boolean	Validates this variable.
wasChanged ( Variables &$vars ) : boolean	Returns whether this variable if it had the "trackchange" option set has actually been changed.

Method Details

Property Details