JApplication/getUserStateFromRequest
From Joomla! Documentation
< API15:JApplication
The "API15" 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.
Description[edit]
Gets the value of a user state variable.
<! removed transcluded page call, red link never existed >
Syntax[edit]
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[edit]
The request user state.
Defined in[edit]
libraries/joomla/application/application.php
Importing[edit]
jimport( 'joomla.application.application' );
Source Body[edit]
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;
}
<! removed transcluded page call, red link never existed >
Examples[edit]
Code Examples[edit]