API16:JSessionStorage/getInstance

Description

Returns a session storage handler object, only creating it if it doesn't already exist.

{{subst:Description:JSessionStorage/getInstance}}

Syntax

static getInstance($name= 'none', $options=array())

Parameter Name	Default Value	Description
$name	'none'	$name The session store to instantiate
$options	array()

Returns

database A object

Defined in

libraries/joomla/session/storage.php

Importing

jimport( 'joomla.session.storage' );

Source Body

public static function getInstance($name = 'none', $options = array())
{
        static $instances;

        if (!isset ($instances)) {
                $instances = array ();
        }

        $name = strtolower(JFilterInput::getInstance()->clean($name, 'word'));
        if (empty ($instances[$name]))
        {
                $class = 'JSessionStorage'.ucfirst($name);
                if (!class_exists($class))
                {
                        $path = dirname(__FILE__).DS.'storage'.DS.$name.'.php';
                        if (file_exists($path)) {
                                require_once $path;
                        } else {
                                // No call to JError::raiseError here, as it tries to close the non-existing session
                                jexit('Unable to load session storage class: '.$name);
                        }
                }

                $instances[$name] = new $class($options);
        }

        return $instances[$name];
}

{{subst:SeeAlso:JSessionStorage/getInstance}}

Examples

<CodeExamplesForm />