Joomla! Documentation™

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.

JForm

Methods

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

• Defined in libraries/joomla/form/form.php

Importing

jimport( 'joomla.form.form' );

See also

• JForm source code on BitBucket
• Subpackage Form
• Other versions of JForm