JModelList::getUserStateFromRequest: Difference between revisions
From Joomla! Documentation
Layout updates |
Updated to r1448:247ba8d88526 |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JModelList::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JModelList::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
<source lang="php"> | <source lang="php"> | ||
public | public function getUserStateFromRequest ( | ||
$key | |||
$request | |||
$default=null | |||
$type= 'none' | |||
$resetPage=true | |||
) | |||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 47: | Line 50: | ||
|- | |- | ||
|} | |} | ||
* '''Returns''' The request user state. | |||
The request user state. | * '''Defined''' on line 320 of libraries/joomla/application/component/modellist.php | ||
* '''Since''' {{JVer|11.1 }} | |||
libraries/joomla/application/component/modellist.php | |||
* | |||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JModelList::getUserStateFromRequest source code''' on [[jplatform:application/component/modellist.php#cl-312|BitBucket]] | |||
* {{JVer|11.1}} Class [[JModelList/11.1|JModelList]] | |||
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]] | |||
* [[JModelList::getUserStateFromRequest|Other versions of JModelList::getUserStateFromRequest]] | |||
{{SeeAlso:JModelList::getUserStateFromRequest}} | |||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JModelList::getUserStateFromRequest|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JModelList::getUserStateFromRequest|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
===User contributed notes=== | |||
=== | |||
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 68: | Line 70: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JModelList]][[Category:JModelList::getUserStateFromRequest]]</noinclude> | <noinclude>[[Category:JModelList]][[Category:JModelList::getUserStateFromRequest]]</noinclude> | ||
Revision as of 02:24, 28 April 2011
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]
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
Template:SeeAlso:JModelList::getUserStateFromRequest [Edit See Also]
User contributed notes
<CodeExamplesForm />