Class Phorm
Phorm
The abstract Phorm class wraps all of the functionality of the form itself. It is extended to created an HTML form. It specifies one abstract method: 'define_fields', which must set an attribute for each field in the form. Fields must be descendents of the PhormField class.
Located in /phorms.php (line 48)
True when the form has user-submitted data.
Private storage for cleaned field values.
A copy of the superglobal data array merged with any default field values provided during class instantiation.
Private storage to collect error messages. Stored as $field_name => $msg.
Private field storage.
The form's method. Determines which superglobal array to use as the data source.
If true, $_FILES is included in the form data. Makes possible file fields.
Memoized return value of the initial is_valid call.
- Phorm::GET|Phorm::POST $method: whether to use GET or POST
- boolean $multi_part: true if this form accepts files
- array $data: initial/default data for form fields (e.g. array('first_name'=>'enter your name'))
Returns the form fields as a series of list items. Does not include the list's opening and closing tags.
Returns the form fields as a series of HTML table rows. Does not include the table's opening and closing tags, nor the table's tbody tags.
Returns true if any of the field's names exist in the source data (or
in $_FILES if this is a multi-part form.)
- array $data
Returns an associative array of the imported form data on a bound, valid form. Returns null if the form is not yet bound or if the form is not valid.
Processes each field's data in turn, calling it's get_value method to access its "cleaned" data.
Returns the form's closing HTML tag.
Abstract method that sets the Phorm's fields as class attributes.
Internal method used by the constructor to find all of the fields in the class after the child's 'define_fields' is called. Returns an array of the field instances.
Returns an iterator that returns each field instance in turn.
Returns the list of errors.
Returns true if the form has errors.
Returns true if the form is bound (i.e., there is data in the appropriate
superglobal array.)
Returns true if all fields' data pass validation tests.
- boolean $reprocess: if true (default: false), call all validators again
Returns the form's opening HTML tag.
- string $target: the form target ($_SERVER['PHP_SELF'] by default)
Sets the value of each field from the proper superglobal data array.
Returns a string of all of the form's fields' HTML tags as a table.
Documentation generated on Mon, 20 Apr 2009 08:29:25 -0400 by phpDocumentor 1.4.2