API17

Difference between revisions of "JApplication::getUserStateFromRequest"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JApplication::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JApplication::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</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 44:
 
|-
 
|-
 
|}
 
|}
===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 (line 515)
 
* see source code in [[jplatform:application/application.php#cl-515|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JApplication::getUserStateFromRequest source code''' on [[jplatform:application/application.php#cl-507|BitBucket]]
 +
* {{JVer|11.1}} Class [[JApplication/11.1|JApplication]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Application/11.1|Application]]
 +
* [[JApplication::getUserStateFromRequest|Other versions of JApplication::getUserStateFromRequest]]
 +
{{SeeAlso:JApplication::getUserStateFromRequest}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JApplication::getUserStateFromRequest|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JApplication::getUserStateFromRequest|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JApplication/11.1|JApplication]]
+
===User contributed notes===
* [[JApplication::getUserStateFromRequest|Other versions of this method]]
 
{{SeeAlso:JApplication::getUserStateFromRequest}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 63: Line 64:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JApplication]][[Category:JApplication::getUserStateFromRequest]]</noinclude>
 
<noinclude>[[Category:JApplication]][[Category:JApplication::getUserStateFromRequest]]</noinclude>

Revision as of 20:08, 27 April 2011

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.

Template:Description:JApplication::getUserStateFromRequest [Edit Descripton]

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]

Template:SeeAlso:JApplication::getUserStateFromRequest [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />