API17

JModelList::getUserStateFromRequest: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Bots
18,905 edits
Bulk upload by Doxiki2
 
m preparing for archive only
 
(6 intermediate revisions by 2 users not shown)
Line 4: Line 4:
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.  
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.  


{{Description:JModelList::getUserStateFromRequest}}
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JModelList::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki>
</span>
===Since===
{{JVer|11.1 }}
===Synopsis===
<source lang="php">
<source lang="php">
public JModelList->getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
public function getUserStateFromRequest (
        $key
        $request
        $default=null
        $type= 'none'
        $resetPage=true
)
</source>
</source>
{| class="wikitable"
{| class="wikitable"
Line 47: Line 48:
|-
|-
|}
|}
===Returns===
* '''Returns''' The request user state.
The request user state.
* '''Defined''' on line 320 of libraries/joomla/application/component/modellist.php
===Defined in===
* '''Since''' {{JVer|11.1 }}
libraries/joomla/application/component/modellist.php
===Referenced by===
===See also===
===See also===
<span class="editsection" style="font-size:76%;">
* {{JVer|11.1}} '''JModelList::getUserStateFromRequest source code''' on [[jplatform:application/component/modellist.php#cl-312|BitBucket]]
<nowiki>[</nowiki>[[SeeAlso:JModelList::getUserStateFromRequest|Edit See Also]]<nowiki>]</nowiki>
* {{JVer|11.1}} Class [[API17:JModelList|JModelList]]
</span>
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Application|Application]]
* [[JModelList/11.1|JModelList]]
* [[API17:JModelList::getUserStateFromRequest|Other versions of JModelList::getUserStateFromRequest]]
* [[JModelList::getUserStateFromRequest|Other versions of this method]]
 
{{SeeAlso:JModelList::getUserStateFromRequest}}
 
===Examples===
===User contributed notes===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
noresultsheader=\n
noresultsheader=\n
category=JModelList::getUserStateFromRequest
category=JModelList::getUserStateFromRequest
category=CodeExample
namespace=CodeExample
category=MethodExample
category=MethodExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:JModelList]][[Category:JModelList::getUserStateFromRequest]]</noinclude>
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 03:28, 25 March 2017

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


User contributed notes

Code Examples


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JModelList::getUserStateFromRequest&oldid=385729"