API17:JForm

The "API17" 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

libraries/joomla/form/form.php

• see source code in BitBucket

Subpackage

Form

Methods

Method name	Description
__construct	Method to instantiate the form object.
bind	Method to bind data to the form.
filter	Method to filter the form data.
getErrors	Return all errors, if any.
getField	Method to get a form field represented as a object.
getFieldAttribute	Method to get an attribute value from a field XML element.
getFieldset	Method to get an array of objects in a given fieldset by name.
getFieldsets	Method to get an array of fieldset objects optionally filtered over a given field group.
getFormControl	Method to get the form control.
getGroup	Method to get an array of objects in a given field group by name.
getInput	Method to get a form field markup for the field input.
getLabel	Method to get a form field markup for the field input.
getName	Method to get the form name.
getValue	Method to get the value of a field.
load	Method to load the form description from an XML string or object.
loadFile	Method to load the form description from an XML file.
removeField	Method to remove a field from the form definition.
removeGroup	Method to remove a group from the form definition.
reset	Method to reset the form data store and optionally the form XML definition.
setField	Method to set a field XML element to the form definition.
setFieldAttribute	Method to set an attribute value for a field XML element.
setFields	Method to set some field XML elements to the form definition.
setValue	Method to set the value of a field.
validate	Method to validate form data.
addFieldPath	Proxy for .
addFormPath	Proxy for .
addRulePath	Proxy for .
getInstance	Method to get an instance of a form.
bindLevel	Method to bind data to the form for the group level.
filterField	Method to apply an input filter to a value based on field data.
findField	Method to get a form field represented as an XML element object.
findFieldsByFieldset	Method to get an array of <field> elements from the form XML document which are in a specified fieldset by name.
findFieldsByGroup	Method to get an array of <field> elements from the form XML document which are in a control group by name.
findGroup	Method to get a form field group represented as an XML element object.
loadField	Method to load, setup and return a object based on field data.
loadFieldType	Proxy for .
loadRuleType	Proxy for .
syncPaths	Method to synchronize any field, form or rule paths contained in the XML document.
validateField	Method to validate a object based on field data.
addNode	Adds a new child SimpleXMLElement node to the source.
mergeNode
mergeNodes	Merges new elements into a source <fields> element.

Importing

jimport( 'joomla.form.form' );

See also

• JForm source code in BitBucket
• Other versions of this class

Examples

<CodeExamplesForm />