API17:JFormField::setup

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

JFormField::setup

Description

Method to attach a object to the field.

Since

Synopsis

public JFormField::setup (&$element, $value, $group=null)

Parameter	Type	Default	Description
&$element	object		$element The object representing the <field> tag for the form field object.
$value	mixed		The form field default value for display.
$group	string	null	The field name group control value. This acts as as an array container for the field. For example if the field has name="foo" and the group value is set to "bar" then the full field name would end up being "bar[foo]".

Returns

boolean True on success.

Defined in

libraries/joomla/form/formfield.php (line 284)

• see source code in BitBucket

See also

• JFormField
• Other versions of this method

Examples

<CodeExamplesForm />