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> <...)
 
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);
 
         }
 
         }

Revision as of 17:09, 22 March 2010

The "API15" 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.

Description[edit]

Gets a user state.

[Edit Descripton]

Template:Description:JApplication/getUserState

Syntax[edit]

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

Returns[edit]

mixed The user state.

Defined in[edit]

libraries/joomla/application/application.php

Importing[edit]

jimport( 'joomla.application.application' );

Source Body[edit]

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

[Edit See Also] Template:SeeAlso:JApplication/getUserState

Examples[edit]

<CodeExamplesForm />