JForm/setField: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Method to replace a field in a group.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</no... |
m preparing for archive only |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Method to replace a field in a group. | Method to replace a field in a group. | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 17: | Line 15: | ||
!Description | !Description | ||
|- | |- | ||
| | | &$field | ||
| | | | ||
| $field The field object to replace. | | $field The field object to replace. | ||
| Line 50: | Line 48: | ||
</source> | </source> | ||
<! removed transcluded page call, red link never existed > | |||
< | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=setField | category=setField | ||
category=JForm | category=JForm | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Latest revision as of 01:41, 25 March 2017
Description
Method to replace a field in a group.
<! removed transcluded page call, red link never existed >
Syntax
setField(&$field, $group= '_default')
| Parameter Name | Default Value | Description |
|---|---|---|
| &$field | $field The field object to replace. | |
| $group | '_default' | $group The group to replace the field in. |
Returns
boolean True on success, false when field does not exist.
Defined in
libraries/joomla/form/form.php
Importing
jimport( 'joomla.form.form' );
Source Body
public function setField(&$field, $group = '_default')
{
$return = false;
// Add the fields to the group if it exists.
if (isset($this->_groups[$group][$field->attributes()->name])) {
$this->_groups[$group][(string)$field->attributes()->name] = $field;
$return = true;
}
return $return;
}
<! removed transcluded page call, red link never existed >
Examples
Code Examples