JForm/setValue: Difference between revisions
From Joomla! Documentation
m removing red link to edit, no existant pages |
m Remove edit junk |
||
| Line 1: | Line 1: | ||
===Description=== | ===Description=== | ||
Method to set the value of a field. | Method to set the value of a field. | ||
===Syntax=== | ===Syntax=== | ||
Revision as of 19:23, 24 June 2015
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 edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />
Above syntax is wrong and doesn't work in Joomla 1.6.1.
The correct is:
$this->form->setValue($field, $group , $value);