Actions

API16

JForm/getValue

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 get the value of a field.

[<! removed edit link to red link >]

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

Syntax

getValue($field, $default=null, $group= '_default')
Parameter Name Default Value Description
$field $field The field to set.
$default null $default The default value of the field if empty.
$group '_default' $group The group the field is in.

Returns

boolean The value of the field or the default value if empty.

Defined in

libraries/joomla/form/form.php

Importing

jimport( 'joomla.form.form' );

Source Body

public function getValue($field, $default = null, $group = '_default')
{
        $return = null;
 
        // Get the field value if it exists.
        if (isset($this->_groups[$group][$field]) && is_object($this->_groups[$group][$field])) {
                $return = array_key_exists($field, $this->_data[$group]) ? $this->_data[$group][$field] : $default;
        }
 
        return $return;
}

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

Examples

<CodeExamplesForm />