JForm/setValue
From Joomla! Documentation
< API16:JForm
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.
Contents
Description
Method to set the value of a field.
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 transcluded page call, red link never existed >
Examples
Code Examples
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