Actions

API16

Difference between revisions of "JForm/setField"

From Joomla! Documentation

< API16:JForm
(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 (removing red link to edit, no existant pages)
 
(One intermediate revision by one user not shown)
Line 3: Line 3:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JForm/setField|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JForm/setField}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 17: Line 17:
 
!Description
 
!Description
 
|-
 
|-
|  
+
| &$field
 
|  
 
|  
 
|  $field The field object to replace.  
 
|  $field The field object to replace.  
Line 51: Line 51:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JForm/setField|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JForm/setField}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 66: Line 66:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API16]]

Latest revision as of 21:53, 13 May 2013

Replacement filing cabinet.png
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.

Contents

Description

Method to replace a field in a group.

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />