JModelList::getUserStateFromRequest

Gets the value of a user state variable and sets it in the session

This is the same as the method in JApplication except that this also can optionally force you back to the first page when a filter has changed

Signature

public function getUserStateFromRequest(string
        $key,
            [string
        $request = null,
            [string
        $default = null,
            [string
        $type = 'none',
            [boolean
        $resetPage = true]]]] )

Parameters

$key: The key of the user state variable.
$request: The name of the variable passed in a request.
$default: The default value for the variable if not found. Optional.
$type: Filter for the variable, for valid values see {@link JFilterInput::clean()}. Optional.
$resetPage: If true, the limitstart in request is set to zero

Returns

The: request user state.