JModelList::getUserStateFromRequest: Difference between revisions
From Joomla! Documentation
m clean up |
m preparing for archive only |
||
| Line 4: | Line 4: | ||
Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed. | Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed. | ||
<source lang="php"> | <source lang="php"> | ||
| Line 56: | Line 56: | ||
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Application|Application]] | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Application|Application]] | ||
* [[API17:JModelList::getUserStateFromRequest|Other versions of JModelList::getUserStateFromRequest]] | * [[API17:JModelList::getUserStateFromRequest|Other versions of JModelList::getUserStateFromRequest]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JModelList::getUserStateFromRequest | category=JModelList::getUserStateFromRequest | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 03:28, 25 March 2017
JModelList::getUserStateFromRequest
Description
Gets the value of a user state variable and sets it in the session This is the same as the method in except that this also can optionally force you back to the first page when a filter has changed.
public function getUserStateFromRequest (
$key
$request
$default=null
$type= 'none'
$resetPage=true
)
| Parameter | Type | Default | Description |
|---|---|---|---|
| $key | string | The key of the user state variable. | |
| $request | string | The name of the variable passed in a request. | |
| $default | string | null | The default value for the variable if not found. Optional. |
| $type | string | 'none' | Filter for the variable, for valid values see . Optional. |
| $resetPage | boolean | true | If true, the limitstart in request is set to zero |
- Returns The request user state.
- Defined on line 320 of libraries/joomla/application/component/modellist.php
- Since
See also
- JModelList::getUserStateFromRequest source code on BitBucket
- Class JModelList
- Subpackage Application
- Other versions of JModelList::getUserStateFromRequest
User contributed notes
Code Examples