Actions

API15

Difference between revisions of "JApplication/getUserState"

From Joomla! Documentation

< API15:JApplication
(New page: ===Description=== Gets a user state. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> <...)
 
m (removing red link to edit, no existant pages)
 
(One intermediate revision by one user not shown)
Line 3: Line 3:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JApplication/getUserState|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JApplication/getUserState}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 32: Line 32:
 
===Source Body===
 
===Source Body===
 
<source lang="php">
 
<source lang="php">
public function getUserState($key)
+
function getUserState( $key )
 
{
 
{
         $session        = &JFactory::getSession();
+
         $session        =& JFactory::getSession();
         $registry      = $session->get('registry');
+
         $registry      =& $session->get('registry');
         if (!is_null($registry)) {
+
         if(!is_null($registry)) {
 
                 return $registry->getValue($key);
 
                 return $registry->getValue($key);
 
         }
 
         }
Line 44: Line 44:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JApplication/getUserState|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JApplication/getUserState}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 59: Line 59:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Latest revision as of 08:33, 12 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Gets a user state.

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

getUserState($key)
Parameter Name Default Value Description
$key The path of the state.

Returns

mixed The user state.

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

function getUserState( $key )
{
        $session        =& JFactory::getSession();
        $registry       =& $session->get('registry');
        if(!is_null($registry)) {
                return $registry->getValue($key);
        }
        return null;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />