JFormField::setup
From 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.
JFormField::setup[edit]
Description[edit]
Method to attach a object to the field.
Template:Description:JFormField::setup [Edit Descripton]
Since[edit]
Synopsis[edit]
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[edit]
boolean True on success.
Defined in[edit]
libraries/joomla/form/formfield.php (line 284)
- see source code in BitBucket
Referenced by[edit]
See also[edit]
Template:SeeAlso:JFormField::setup
Examples[edit]
<CodeExamplesForm />