input_form
Input form class.
This class defines an input form and has methods for adding form objects to the form, displaying the form, and requesting the forms state.
Located in /input.form.php (line 36)
input_form
input_form
(string $name, [string $location = NULL], [mixed $method = INFUSE_POST], [string $submit = INFUSE_FORM_DEFAULT_SUBMIT], [string $reset = INFUSE_FORM_DEFAULT_RESET], [string $cancel = INFUSE_FORM_DEFAULT_CANCEL])
bool
$areRequiredValid
(line 106)
True if all required form elements are valid
string
$cancel
(line 84)
Caption of the cancel button.
bool
$isFormValid
(line 99)
Overall validity of form elements True if all added form elements are valid
string
$location
(line 50)
URI for form to submit to.
int
$method
(line 57)
The submit method to use: INFUSE_POST or INFUSE_GET
string
$name
(line 43)
The name of the form.
array
$objects
= array() (line 91)
Form objects in this form.
array
$other_submit
= array() (line 70)
Additional submit buttons
string
$reset
(line 77)
Caption of the reset button.
string
$submit
(line 64)
Caption of the submit button.
Constructor input_form (line 118)
Constructs a new form object.
- string $name: The name of the form.
- string $location: URI for form to submit to.
- mixed $method: The submit method to use ('get', 'post', INFUSE_GET, INFUSE_POST)
- string $submit: Caption of the submit button.
- string $reset: Caption of the reset button.
- string $cancel: Caption of the cancel button.
addObject (line 187)
Add a form object to the form.
- object $object: The form object to add.
addSubmitButton (line 241)
Add additional submit button.
- string $name: "Functional" name of button, e.g. edit_button.
- string $caption: "Display" name of button, e.g. Edit
addToGroup (line 215)
Add to a group of elements under one name ( nested array )
- string $group: Name of element group
- object $object: The form object to add.
cancelled (line 276)
Has the form been cancelled? Can be called statically.
clearPost (line 287)
Clear form post values.
display_buttons (line 347)
Display configured form buttons using optional specified class.
Buttons are displayed in the following order: Submit Other submit (preview, edit, delete, whatever) two if reset or cancel buttons are present Reset (if present) Cancel (if present)
name and id attributes are both assigned as follows: submit: <form name>_submit other submit: <form name>_<other name> (e.g. user_edit) reset: <form name>_reset cancel: input_form_cancel <-- only need one cancel button.
- string $button_class: Name of class assigned to span tag surrounding buttons.
display_elements (line 325)
Basic display of form elements. Very crude. Your own templates can do better...
display_end (line 397)
Display the closing form tag.
display_start (line 308)
Display the form header.
Displays the beginning of the form in xhtml compliant fashion with the following attributes:
enctype multipart/form-data id assigned form name method get/post action assigned location class class passed as parameter, if any
This method should be used in conjunction with input_form::display_end.
- string $form_class: CSS class to be assigned to this form
otherSubmitted (line 250)
Has the form been submitted with one of the 'other' buttons?
- string $name: "Functional" name of button to check, e.g. edit_button
reset (line 145)
Calls reset all form elements
- string $group: Name of specific group of elements to reset
submitted (line 263)
Has the form been submitted?
_constantToString (line 466)
Convert constants to appropriate method string for rendered form.
_dispArray (line 409)
Print array elements within a table.
- mixed $elemArray: Reference to element array to display
_parmToConstant (line 441)
Convert input parameters to defined constants for form method.
- mixed $in_parm: String or constant specifying where form input can be found.
_resetArray (line 163)
Utility function Reset contents of given array
- mixed $objArray: Reference to array to reset.
Documentation generated on Fri, 28 Jan 2005 10:00:56 -0800 by phpDocumentor 1.2.3