API17:JModelList::getUserStateFromRequest
From Joomla! Documentation
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.
Template:Description:JModelList::getUserStateFromRequest [Edit Descripton]
Since
Synopsis
public JModelList->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 in
libraries/joomla/application/component/modellist.php
Referenced by
See also
Template:SeeAlso:JModelList::getUserStateFromRequest
Examples
<CodeExamplesForm />