API16:JSession/set

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.

Description

Set data into the session store.

Syntax

set($name, $value=null, $namespace= 'default')

Parameter Name	Default Value	Description
$name		Name of a variable.
$value	null	Value of a variable.
$namespace	'default'	Namespace to use, default to 'default'.

Returns

mixed Old value of a variable.

Defined in

libraries/joomla/session/session.php

Importing

jimport( 'joomla.session.session' );

Source Body

public function set($name, $value = null, $namespace = 'default')
{
        $namespace = '__'.$namespace; //add prefix to namespace to avoid collisions
 
        if ($this->_state !== 'active') {
                // @TODO :: generated error here
                return null;
        }
 
        $old = isset($_SESSION[$namespace][$name]) ?  $_SESSION[$namespace][$name] : null;
 
        if (null === $value) {
                unset($_SESSION[$namespace][$name]);
        } else {
                $_SESSION[$namespace][$name] = $value;
        }
 
        return $old;
}

Examples

<CodeExamplesForm />