Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Attributs protégés statiques
Référence de la classe JSessionStorage
+ Graphe d'héritage de JSessionStorage:

Liste de tous les membres

Fonctions membres publiques

 __construct ($options=array())
 register ()
 open ($save_path, $session_name)
 close ()
 read ($id)
 write ($id, $session_data)
 destroy ($id)
 gc ($maxlifetime=null)

Fonctions membres publiques statiques

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

Attributs protégés statiques

static $instances = array()

Description détaillée

Définition à la ligne 21 du fichier storage.php.

Documentation des constructeurs et destructeur

JSessionStorage::__construct (   $options = array())

Constructor

Paramètres:
array$optionsOptional parameters.
Depuis:
11.1

Réimplémentée dans JSessionStorageApc, JSessionStorageMemcache, JSessionStorageMemcached, JSessionStorageWincache, et JSessionStorageXcache.

Définition à la ligne 36 du fichier storage.php.

{
$this->register($options);
}

Documentation des fonctions membres

JSessionStorage::close ( )

Close the SessionHandler backend.

Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Définition à la ligne 118 du fichier storage.php.

{
return true;
}
JSessionStorage::destroy (   $id)

Destroy the data for a particular session identifier in the SessionHandler backend.

Paramètres:
string$idThe session identifier.
Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Réimplémentée dans JSessionStorageDatabase, JSessionStorageXcache, et JSessionStorageApc.

Définition à la ligne 163 du fichier storage.php.

{
return true;
}
JSessionStorage::gc (   $maxlifetime = null)

Garbage collect stale sessions from the SessionHandler backend.

Paramètres:
integer$maxlifetimeThe maximum age of a session.
Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Réimplémentée dans JSessionStorageDatabase.

Définition à la ligne 177 du fichier storage.php.

{
return true;
}
static JSessionStorage::getInstance (   $name = 'none',
  $options = array() 
)
static

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

Paramètres:
string$nameThe session store to instantiate
array$optionsArray of options
Renvoie:
JSessionStorage
Depuis:
11.1

Définition à la ligne 51 du fichier storage.php.

Références JFilterInput\getInstance(), et jexit().

Référencé par JSession\__construct().

{
$name = strtolower(JFilterInput::getInstance()->clean($name, 'word'));
if (empty(self::$instances[$name]))
{
$class = 'JSessionStorage' . ucfirst($name);
if (!class_exists($class))
{
$path = __DIR__ . '/storage/' . $name . '.php';
if (file_exists($path))
{
require_once $path;
}
else
{
// No attempt to die gracefully here, as it tries to close the non-existing session
jexit('Unable to load session storage class: ' . $name);
}
}
self::$instances[$name] = new $class($options);
}
return self::$instances[$name];
}

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

static JSessionStorage::isSupported ( )
static

Test to see if the SessionHandler is available.

Renvoie:
boolean True on success, false otherwise.
Depuis:
12.1

Réimplémentée dans JSessionStorageXcache, JSessionStorageApc, JSessionStorageMemcache, JSessionStorageMemcached, et JSessionStorageWincache.

Définition à la ligne 189 du fichier storage.php.

{
return true;
}
JSessionStorage::open (   $save_path,
  $session_name 
)

Open the SessionHandler backend.

Paramètres:
string$save_pathThe path to the session object.
string$session_nameThe name of the session.
Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Définition à la ligne 106 du fichier storage.php.

{
return true;
}
JSessionStorage::read (   $id)

Read the data for a particular session identifier from the SessionHandler backend.

Paramètres:
string$idThe session identifier.
Renvoie:
string The session data.
Depuis:
11.1

Réimplémentée dans JSessionStorageApc, JSessionStorageXcache, et JSessionStorageDatabase.

Définition à la ligne 133 du fichier storage.php.

{
return;
}
JSessionStorage::register ( )

Register the functions of this class with PHP's session handler

Renvoie:
void
Depuis:
11.1

Réimplémentée dans JSessionStorageMemcache, JSessionStorageMemcached, JSessionStorageWincache, et JSessionStorageNone.

Définition à la ligne 87 du fichier storage.php.

{
// Use this object as the session handler
session_set_save_handler(
array($this, 'open'), array($this, 'close'), array($this, 'read'), array($this, 'write'),
array($this, 'destroy'), array($this, 'gc')
);
}
static JSessionStorage::test ( )
static

Test to see if the SessionHandler is available.

Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1
Obsolète:
12.3 (Platform) & 4.0 (CMS) - Use JSessionStorage::isSupported() instead.

Définition à la ligne 202 du fichier storage.php.

Références JLog\add(), et JLog\WARNING.

{
JLog::add('JSessionStorage::test() is deprecated. Use JSessionStorage::isSupported() instead.', JLog::WARNING, 'deprecated');
return static::isSupported();
}

+ Voici le graphe d'appel pour cette fonction :

JSessionStorage::write (   $id,
  $session_data 
)

Write session data to the SessionHandler backend.

Paramètres:
string$idThe session identifier.
string$session_dataThe session data.
Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

Réimplémentée dans JSessionStorageXcache, JSessionStorageDatabase, et JSessionStorageApc.

Définition à la ligne 148 du fichier storage.php.

{
return true;
}

Documentation des données membres

JSessionStorage::$instances = array()
staticprotected

Définition à la ligne 27 du fichier storage.php.

La documentation de cette classe a été générée à partir du fichier suivant :