JSessionStorage/getInstance
From Joomla! Documentation
< API16:JSessionStorage
The "API16" 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]
Returns a session storage handler object, only creating it if it doesn't already exist.
Syntax[edit]
static getInstance($name= 'none', $options=array())
Parameter Name | Default Value | Description |
---|---|---|
$name | 'none' | $name The session store to instantiate |
$options | array() |
Returns[edit]
database A object
Defined in[edit]
libraries/joomla/session/storage.php
Importing[edit]
jimport( 'joomla.session.storage' );
Source Body[edit]
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];
}
Examples[edit]
Code Examples[edit]