API17:JApplication::getUserStateFromRequest
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JApplication::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JApplication::getUserStateFromRequest|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function getUserStateFromRequest ( |
| + | $key | ||
| + | $request | ||
| + | $default=null | ||
| + | $type= 'none' | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 42: | Line 44: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' The request user state. | |
| − | The request user state. | + | * '''Defined''' on line 515 of libraries/joomla/application/application.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/application/application.php | + | |
| − | + | ||
===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> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 62: | 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
JApplication::getUserStateFromRequest
Description
Gets the value of a user state variable.
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
See also
- JApplication::getUserStateFromRequest source code on BitBucket
- Class JApplication
- Subpackage Application
- Other versions of JApplication::getUserStateFromRequest
SeeAlso:JApplication::getUserStateFromRequest [Edit See Also]
User contributed notes
<CodeExamplesForm />
