API17

Difference between revisions of "JApplication::getUserStateFromRequest"

From Joomla! Documentation

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

Latest revision as of 21:19, 24 March 2017

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 JApplication::getUserStateFromRequest[edit]

Description[edit]

Gets the value of a user state variable.


public function getUserStateFromRequest (
        $key
        $request
        $default=null
        $type= 'none'
)
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.
  • Returns The request user state.
  • Defined on line 515 of libraries/joomla/application/application.php
  • Since Joomla 11.1

See also[edit]


User contributed notes[edit]

Code Examples[edit]