Référence de la classe Storage

Graphe d'héritage de Storage:

Fonctions membres publiques
	__construct ($options=array())
	register ()
	open ($savePath, $sessionName)
	close ()
	read ($id)
	write ($id, $sessionData)
	destroy ($id)
	gc ($maxlifetime=null)

Fonctions membres publiques statiques
static	getInstance ($name='none', $options=array())
static	isSupported ()

Attributs protégés statiques
static	$instances = array()

Description détaillée

Custom session storage handler for PHP

1.0 deprecated 1164.

Documentation des constructeurs et destructeur

__construct()

__construct

(

$options = array()

)

Constructor

Paramètres

array

$options

Optional parameters.

Depuis

1.0

Obsolète:

2.0

Références $options.

Documentation des fonctions membres

close()

close

(

)

Close the SessionHandler backend.

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

destroy()

destroy

(

$id

)

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

Paramètres

string

$id

The session identifier.

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

gc()

gc

(

$maxlifetime = null

)

Garbage collect stale sessions from the SessionHandler backend.

Paramètres

integer

$maxlifetime

The maximum age of a session.

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

getInstance()

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

static

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

Paramètres

string	$name	The session store to instantiate
array	$options	Array of options

Renvoie

Storage

Depuis

1.0

Obsolète:

2.0

Références $class, $filter, $name, $options, et $path.

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

isSupported()

static isSupported ( )

static

Test to see if the SessionHandler is available.

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

open()

open	(		$savePath,
			$sessionName
	)

Open the SessionHandler backend.

Paramètres

string	$savePath	The path to the session object.
string	$sessionName	The name of the session.

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

read()

read

(

$id

)

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

Paramètres

string

$id

The session identifier.

Renvoie

string The session data.

Depuis

1.0

Obsolète:

2.0

register()

register

(

)

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

Renvoie

void

Depuis

1.0

Obsolète:

2.0

write()

write	(		$id,
			$sessionData
	)

Write session data to the SessionHandler backend.

Paramètres

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

Renvoie

boolean True on success, false otherwise.

Depuis

1.0

Obsolète:

2.0

Documentation des champs

$instances

$instances = array()

staticprotected

---

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

• Storage.php