From Joomla! Documentation

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Defined in[edit]



Method name Description
getInstance Method to get an instance of a form.
addFormPath Method to add a path to the list of form include paths.
addFieldPath Method to add a path to the list of field include paths.
__construct Method to construct the object on instantiation.
getName Method to get the form name.
setName Method to set the form name.
bind Method to recursively bind values to form fields.
load Method to load the form description from a file or string.
loadFolder Method to load form descriptions from a complete folder.
filter Method to recursively filter data for form fields.
validate Method to validate form data.
addField Method to add a field to a group.
addFields Method to add an array of fields to a group.
getField Method to get a form field.
getFieldAttribute Method to get a field attribute value.
setField Method to replace a field in a group.
removeField Method to remove a field from a group.
setFieldAttribute Method to set a field attribute value.
getFields Method to get the fields in a group.
setFields Method to assign an array of fields to a group.
getFieldset Method to get a set of fields.
getGroups Method to get a list of groups.
removeGroup Method to remove a group.
getInput Method to get the input control for a field.
getLabel Method to get the label for a field.
getValue Method to get the value of a field.
setValue Method to set the value of a field.
loadFieldsXML Loads form fields from an XML fields element optionally reseting fields before loading new ones.
loadFieldType Method to load a form field object.


jimport( 'joomla.form.form' );


Code Examples[edit]