$error

True if an error in this form was detected.

$formErrors

An array of errors that are not particular to an individual field.

$formFields

Stores the fields in this form in display order.

$formListeners

Callback classes that processes certain form actions.

$formName

The value of the name attribute in the form tag.

$isError

True if an error in this form was detected.

$validators

Callback classes that process form validation.

FfForm()

The FfForm constructor.

__construct()

The FfForm constructor.

__toString()

Returns HTML that displays this form's field values in a nicely formatted table.

addField(FormField formField, string afterFieldName)

Adds or inserts a field into this form's field list.

addFieldToFront(FormField formField)

Inserts a field at the front of the field list.

addFields(FfForm ffForm, string afterFieldName)

Adds all the fields from another form to this form.

addFormError(string error)

Adds a form error string to the end of the form error list.

addFormListener(mixed formListener)

Adds a form listener to this form, a callback class that processes certain form actions like assigning default field values.

addFormValidator(mixed formValidator)

Adds a form validator, callback classes that are used to implement form validation.

addSingleRow(string fieldName, TableSet table, string hiddenFields, string buttons)

Adds a row, appends a hidden field or appends a button for the specified field.

checkValues()

Performs field value validation for this form and using any form validators.

clearAllData()

Clears the values of all the fields in this form.

clearValue(string name)

Clears a field's value.

containsData()

Returns true if this form contains data.

copyAllFields(mixed ffForm, mixed afterFieldName)

Copies all fields from another form to this form.

copyFields(FfForm ffForm, array fieldsToCopy)

Copies fields from another form to this form, including any field data and field errors.

copyValues(FfForm ffForm)

Copies the field values from another form as long as the field name exists in this form.

diff(FfForm oldFfForm, array ignoreFieldNames)

Returns an associative array indexed by field name where each element is an array of {,}

disableField(FormField name)

Disables a field in this form.

email(string to, string subject, string from, string cc, string bcc, string msgHeader, string msgFooter, array attachments, mixed useHtml, string cssFile, boolean sendFormData, boolean sendFormUploads, useHtml false)

Sends an HTML or clear text email.

fieldExists(string fieldName)

Returns true if the field exists.

fieldsExist(array fieldNames)

Returns true if all the fields exist.

getButtonClicked()

Returns true if a submit button was clicked.

getDbValue(string name)

Returns the database value of a field in this form.

getDbValues(array fieldNames)

Returns an associative array of database values for fields in this form.

getDisableJs(array fieldNames, mixed exceptFieldNames, array exceptfieldNames)

Returns JavaScript code to disable all fields during run-time.

getDisplayTableTag(string classPostfix, boolean showDescriptions, mixed showFieldHelp, boolean displayHelp)

Returns the HTML to display this form in display mode.

getEmailMessage(string message, string msgHeader, string msgFooter, array attachments, mixed useHtml, string cssFile, boolean sendFormData, boolean sendFormUploads, useHtml false)

Returns the readable section of the email message.

getError()

Returns true if an error in the this form was detected

getField(string fieldName)

Returns a field from this form.

getFieldErrors()

Returns an array of form errors.

getFieldLabel(string fieldName)

Returns the field's label.

getFieldLabels(array fieldNames)

Returns an array of field labels.

getFieldName(string fieldLabel)

Returns the field's name.

getFieldNames(array fieldLabels)

Returns an array of field names.

getFieldTag(string name)

Returns the HTML that displays the input field.

getFormName()

Returns the value of the name attribute in the form tag.

getHiddenFieldTag(string name)

Returns the HTML that describes this field as a hidden field

getIfError()

Returns an error formatted in HTML if this form has any errors.

getLabelTag(string name)

Returns the HTML that displays the field label.

getParameters()

Retrieves the posted form values.

getRawMailMessage(string message, string additionalHeaders, array attachments, mixed useHtml, useHtml false)

Returns the raw multipart content of an email.

getSingleFieldTableTag(string name)

Returns the HTML to display a form with just a single field from this form.

getTableTag(string classPostfix)

Returns the HTML to display this form in editing mode.

getValue(string name)

Returns a field's value.

getValueIfExists(string name)

Returns the value of a field if it exists in this form.

getValues(array fieldNames)

Returns an associative array of values for fields in this form.

insertValuesIntoDb(string tableName, boolean ignoreError)

Inserts values in the specified table according to the database values of the fields in this form.

isBlank(string name)

Returns true if the field value is blank such as when the user hasn't filled in the value.

isEmpty(mixed fieldName, string name)

Returns true if the field value is blank such as when the user hasn't filled in the value.

keepFields(array fieldNames)

Removes all fields except those specified.

loadDbValues(array assocArray)

Loads database field values from an associative array where the index is the field name.

loadDbValuesNoCreate(array assocArray)

Loads database field values from an associative array where the index is the field name.

loadValuesFromDb(string tableName, string whereClause, boolean ignoreError)

Loads the database values of the fields in this form.

loadValuesFromQuery(string sql, boolean ignoreError)

Loads the database values of the fields in this form from a specified SQL query.

mail(string to, string subject, string message, string additionalHeaders, mixed additionalParameters, string from, string cc, string bcc, array attachments, mixed useHtml, string additionalParameter, useHtml false)

Sends an HTML or clear text email.

performActions()

Uses the form listener and any appropriate button listener to perform the form actions.

process()

Retrieves submitted form values and then uses the button listener, form listener and any appropriate button listener to perform the form actions.

removeAllEmptyFields(array exceptFieldNames)

Removes all empty fields.

removeField(string fieldName)

Removes a field from this form.

removeFields(array fieldNames)

Removes fields from this form

setDbValue(string name, string value)

Sets the database value of a field in this form.

setEditable(boolean editable)

Enable or disable editing of a field in this form.

setEditableFields(array fieldNames, boolean editable)

Enables or disables editing of fields in this form.

setEnabled(boolean enabled)

Enable or disable a field in this form.

setEnabledFields(array fieldNames, boolean enabled)

Enables or disables fields in this form.

setEnterTabs(boolean enterTabs)

Sets whether pressing enter on an input field submits the form or moves the focus to the next element.

setError(FormField name, string error)

Sets the error string for a field in this form.

setFormName(string formName)

Sets the value of the name attribute in the form tag.

setHelp(string fieldName, string help)

Sets the field help of a field in this form.

setHiddenFields(array fieldNames, boolean isHidden)

Hides or shows the specified fields.

setValue(string name, string value)

Sets the value of a field in this form.

toString()

Returns HTML that displays this form's field values in a nicely formatted table.

trackedUpdate(string tableName, string whereClause, string userId, string primaryKey, array ignoreFieldNames, string attrChangesTableName, boolean ignoreError)

Uses the attribute changes construct in FfDbHelper to record the difference between the new data in this form and the old saved data in the database and then updates the data in the database with this form's new data.

updateValuesInDb(string tableName, string whereClause, boolean ignoreError)

Updates the values in the specified table according to the database values of the fields in this form.

validate()

Performs field value validation for this form.