API16

JForm/setField

From Joomla! Documentation

< API16:JForm
Revision as of 05:14, 30 March 2010 by Doxiki (talk | contribs)

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.

[Edit Descripton]

Template:Description:JForm/setField

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;
}

[Edit See Also] Template:SeeAlso:JForm/setField

Examples[edit]

<CodeExamplesForm />