Actions

API16

JForm/setValue

From Joomla! Documentation

< API16:JForm
Revision as of 21:53, 13 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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 set the value of a field.

[<! removed edit link to red link >]

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

Syntax

setValue($field, $value, $group= '_default')
Parameter Name Default Value Description
$field $field The field to set.
$value $value The value to set the field to.
$group '_default' $group The group the field is in.

Returns

boolean True if field exists, false otherwise.

Defined in

libraries/joomla/form/form.php

Importing

jimport( 'joomla.form.form' );

Source Body

public function setValue($field, $value, $group = '_default')
{
        // Set the field if it exists.
        if (isset($this->_groups[$group][$field]) && is_object($this->_groups[$group][$field])) {
                $this->_data[$group][$field] = $value;
                return true;
        } else {
                return false;
        }
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />

Wrong description

Above syntax is wrong and doesn't work in Joomla 1.6.1.

The correct is:

$this->form->setValue($field, $group , $value);

Bornakke 15:59, 13 April 2011 (CDT) Edit comment