JForm/setValue: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Method to set the value of a field.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi... |
m preparing for archive only |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
===Description=== | ===Description=== | ||
Method to set the value of a field. | Method to set the value of a field. | ||
===Syntax=== | ===Syntax=== | ||
| Line 52: | Line 46: | ||
</source> | </source> | ||
<! removed transcluded page call, red link never existed > | |||
< | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=setValue | category=setValue | ||
category=JForm | category=JForm | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Latest revision as of 01:42, 25 March 2017
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 >
Above syntax is wrong and doesn't work in Joomla 1.6.1.
The correct is:
$this->form->setValue($field, $group , $value);