Actions

API16

JApplication/getUserStateFromRequest

From Joomla! Documentation

< API16:JApplication
Revision as of 17:35, 22 March 2010 by Doxiki (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

Gets the value of a user state variable.

[Edit Descripton]

Description:JApplication/getUserStateFromRequest

Syntax

getUserStateFromRequest($key, $request, $default=null, $type= 'none')
Parameter Name Default Value Description
$key The key of the user state variable.
$request The name of the variable passed in a request.
$default null The default value for the variable if not found. Optional.
$type 'none' Filter for the variable, for valid values see . Optional.

Returns

The request user state.

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

public function getUserStateFromRequest($key, $request, $default = null, $type = 'none')
{
        $old_state = $this->getUserState($key);
        $cur_state = (!is_null($old_state)) ? $old_state : $default;
        $new_state = JRequest::getVar($request, null, 'default', $type);
 
        // Save the new value only if it was set in this request.
        if ($new_state !== null) {
                $this->setUserState($key, $new_state);
        } else {
                $new_state = $cur_state;
        }
 
        return $new_state;
}

[Edit See Also] SeeAlso:JApplication/getUserStateFromRequest

Examples

<CodeExamplesForm />