API16

Difference between revisions of "JForm/setField"

From Joomla! Documentation

< API16:JForm
m (preparing for archive only)
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
Method to replace a field in a group.
 
Method to replace a field in a group.
  
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JForm/setField|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
  
{{Description:JForm/setField}}
+
 
 +
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 50: Line 48:
 
</source>
 
</source>
  
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[SeeAlso:JForm/setField|Edit See Also]]<nowiki>]</nowiki>
+
<! removed transcluded page call, red link never existed >
</span>
 
{{SeeAlso:JForm/setField}}
 
  
 
===Examples===
 
===Examples===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
  noresultsheader=\n
 
  noresultsheader=\n
 
  category=setField
 
  category=setField
 
  category=JForm
 
  category=JForm
  category=CodeExample
+
  namespace=CodeExample
 
  category=MethodExample
 
  category=MethodExample
 
  include=*
 
  include=*
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API16]]

Latest revision as of 20:41, 24 March 2017

The "API16" 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.

Description[edit]

Method to replace a field in a group.


<! removed transcluded page call, red link never existed >

Syntax[edit]

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[edit]

boolean True on success, false when field does not exist.

Defined in[edit]

libraries/joomla/form/form.php

Importing[edit]

jimport( 'joomla.form.form' );

Source Body[edit]

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[edit]

Code Examples[edit]