JApplication/getUserStateFromRequest: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Gets the value of a user state variable.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JApplication/getUserStateFromRequest|Edit ... |
m removing red link to edit, no existant pages |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 62: | Line 62: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
| Line 77: | Line 77: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Revision as of 01:57, 13 May 2013
Description
Gets the value of a user state variable.
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
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;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
<CodeExamplesForm />