API16

API16:JSession/get

From Joomla! Documentation

Revision as of 22:42, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Get data from the session store <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> <...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Get data from the session store

[Edit Descripton]

Template:Description:JSession/get

Syntax

get($name, $default=null, $namespace= 'default')
Parameter Name Default Value Description
$name Name of a variable
$default null Default value of a variable if not set
$namespace 'default' Namespace to use, default to 'default'

Returns

mixed Value of a variable

Defined in

libraries/joomla/session/session.php

Importing

jimport( 'joomla.session.session' );

Source Body

public function get($name, $default = null, $namespace = 'default')
{
        $namespace = '__'.$namespace; //add prefix to namespace to avoid collisions

        if ($this->_state !== 'active' && $this->_state !== 'expired') {
                // @TODO :: generated error here
                $error = null;
                return $error;
        }

        if (isset($_SESSION[$namespace][$name])) {
                return $_SESSION[$namespace][$name];
        }
        return $default;
}

[Edit See Also] Template:SeeAlso:JSession/get

Examples

<CodeExamplesForm />