Référence de la classe JSessionStorage

Graphe d'héritage de JSessionStorage:

Graphe de collaboration de JSessionStorage:

Liste de tous les membres

Fonctions membres publiques

• __construct ($options=array())
• & getInstance ($name= 'none', $options=array())
• register ($options=array())
• open ($save_path, $session_name)
• close ()
• read ($id)
• write ($id, $session_data)
• destroy ($id)
• gc ($maxlifetime)

Fonctions membres publiques statiques

• test ()

---

Documentation des constructeurs et destructeur

JSessionStorage::__construct

(

$

options = array()

)

Constructor

protected

Paramètres:

array

$options

optional parameters

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

---

Documentation des fonctions membres

JSessionStorage::close

(

)

Close the SessionHandler backend.

public

Renvoie:

boolean True on success, false otherwise.

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

JSessionStorage::destroy

(

$

id

)

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

public

Paramètres:

string

$id

The session identifier.

Renvoie:

boolean True on success, false otherwise.

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

JSessionStorage::gc

(

$

maxlifetime

)

Garbage collect stale sessions from the SessionHandler backend.

public

Paramètres:

integer

$maxlifetime

The maximum age of a session.

Renvoie:

boolean True on success, false otherwise.

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

& JSessionStorage::getInstance	(	$	name = 'none',
		$	options = array()
	)

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

public

Paramètres:

name

$name

The session store to instantiate

Renvoie:

database A JSessionStorage object

Depuis:

1.5

Références $class, $name, $path, JFilterInput::clean(), et jexit().

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

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JSessionStorage::open	(	$	save_path,
		$	session_name
	)

Open the SessionHandler backend.

public

Paramètres:

string	$save_path	The path to the session object.
string	$session_name	The name of the session.

Renvoie:

boolean True on success, false otherwise.

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

JSessionStorage::read

(

$

id

)

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

public

Paramètres:

string

$id

The session identifier.

Renvoie:

string The session data.

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

JSessionStorage::register

(

$

options = array()

)

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

public

Paramètres:

array

$options

optional parameters

JSessionStorage::test

(

)

[static]

Test to see if the SessionHandler is available.

public

Renvoie:

boolean True on success, false otherwise.

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

JSessionStorage::write	(	$	id,
		$	session_data
	)

Write session data to the SessionHandler backend.

public

Paramètres:

string	$id	The session identifier.
string	$session_data	The session data.

Renvoie:

boolean True on success, false otherwise.

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

---

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

• session/storage.php