Actions

API17

JModelList::getUserStateFromRequest

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 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 Joomla 11.1

See also

  • Joomla 11.1 JModelList::getUserStateFromRequest source code on BitBucket
  • Joomla 11.1 Class JModelList
  • Joomla 11.1 Subpackage Application
  • Other versions of JModelList::getUserStateFromRequest


User contributed notes

Code Examples


Advertisement