FormInput Class Reference

This class represents an input for an xform. More...

List of all members.

Public Member Functions

 __construct ($inputType, $label, $ref="", $validType="", $required="", $value="", $items="", $appearance="", $description="")
 Builds a new input object.
 buildInput ()
 this builds the tags for an input in the middle of an xform, determining the layout and description for an input.
 buildInstance ()
 this builds an instance at top of the xform, determining a validation type and whether a value is required.
 setDescription ($d)
 sets the description to a new value.

Protected Attributes

 $appearance
 the appearance of the input (ie: minimal or not)
 $description
 a description for the input
 $inputType
 the type of input (textbox, dropdown, etc)
 $items
 the list of choices for a dropdown box or set of check boxes
 $label
 the label that will be displayed with the input
 $ref
 the reference for the input (used for reading values from the xform)
 $required
 whether or not this input is a required element of the form
 $validType
 the validation type for this input according to StandardValidator
 $value
 the default value of the input (optional)


Detailed Description

This class represents an input for an xform.

Definition at line 6 of file FormInput.php5.


Constructor & Destructor Documentation

FormInput::__construct ( inputType,
label,
ref = "",
validType = "",
required = "",
value = "",
items = "",
appearance = "",
description = "" 
)

Builds a new input object.

Parameters:
$inputType [string]: what type of input (e.g., textbox, dropdown)
$label [string]: label displayed with input
$ref [string]: XML reference for input
$validType [string]: validation type for this input according to SValidator
$required [boolean]: whether input is required for this form
$value [mixed]: default value for input
$items [mixed]: list of choices for dropdown box or set of check boxes
$appearance [string]: appearance of input (e.g., minimal or not)
$description [string]: additional description for input

Definition at line 58 of file FormInput.php5.

References $appearance, $description, $inputType, $items, $label, $ref, $required, $validType, and $value.


Member Data Documentation

FormInput::$appearance [protected]

the appearance of the input (ie: minimal or not)

For internal use only.

Definition at line 38 of file FormInput.php5.

Referenced by __construct().

FormInput::$description [protected]

a description for the input

For internal use only.

Definition at line 42 of file FormInput.php5.

Referenced by __construct(), and buildInput().

FormInput::$inputType [protected]

the type of input (textbox, dropdown, etc)

For internal use only.

Definition at line 10 of file FormInput.php5.

Referenced by __construct().

FormInput::$items [protected]

the list of choices for a dropdown box or set of check boxes

For internal use only.

Definition at line 34 of file FormInput.php5.

Referenced by __construct().

FormInput::$label [protected]

the label that will be displayed with the input

For internal use only.

Definition at line 14 of file FormInput.php5.

Referenced by __construct(), and buildInput().

FormInput::$ref [protected]

the reference for the input (used for reading values from the xform)

For internal use only.

Definition at line 18 of file FormInput.php5.

Referenced by __construct().

FormInput::$required [protected]

whether or not this input is a required element of the form

For internal use only.

Definition at line 26 of file FormInput.php5.

Referenced by __construct().

FormInput::$validType [protected]

the validation type for this input according to StandardValidator

For internal use only.

Definition at line 22 of file FormInput.php5.

Referenced by __construct().

FormInput::$value [protected]

the default value of the input (optional)

For internal use only.

Definition at line 30 of file FormInput.php5.

Referenced by __construct(), and buildInstance().


The documentation for this class was generated from the following file:

Generated on Wed Nov 24 02:05:51 2010 for Common by  doxygen 1.5.6