JModelList::getUserStateFromRequest: Difference between revisions

Revision as of 02:00, 24 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]

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 (line 320)

see source code in BitBucket

Referenced by

Examples

@@ Line 12: / Line 12: @@
 ===Synopsis===
 <source lang="php">
-public  JModelList->getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
+public JModelList::getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
 </source>
 {| class="wikitable"
@@ Line 50: / Line 50: @@
 The request user state.
 ===Defined in===
-libraries/joomla/application/component/modellist.php
+libraries/joomla/application/component/modellist.php (line 320)
+* see source code in [[jplatform:application/component/modellist.php#cl-320|BitBucket]]
 ===Referenced by===
 ===See also===

API17