Référence de la classe DatabaseHandler

Graphe d'héritage de DatabaseHandler:

Fonctions membres publiques
	__construct (DatabaseInterface $db)
	close ()
	createDatabaseTable ()
	destroy ($session_id)
	gc ($maxlifetime)
	open ($save_path, $session_id)
	read ($session_id)
	write ($session_id, $session_data)

Fonctions membres publiques statiques
static	isSupported ()

Attributs privés
	$db
	$gcCalled = false
	$gcLifetime

Description détaillée

Database session storage handler

Depuis

2.0.0

Documentation des constructeurs et destructeur

__construct()

__construct

(

DatabaseInterface

$db

)

Constructor

Paramètres

DatabaseInterface

$db

Database connector

Depuis

2.0.0

Références DatabaseHandler\$db.

Documentation des fonctions membres

close()

close

(

)

Close the session

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

Références $query, ParameterType\INTEGER, et null.

createDatabaseTable()

createDatabaseTable

(

)

Creates the session database table

Renvoie

boolean

Depuis

2.0.0

Exceptions

CreateSessionTableException
UnsupportedDatabaseDriverException

Références $path, $query, __DIR__, et DatabaseDriver\splitSql().

destroy()

destroy

(

$session_id

)

Destroy a session

Paramètres

integer

$session_id

The session ID being destroyed

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

Références $query.

gc()

gc

(

$maxlifetime

)

Cleanup old sessions

Paramètres

integer

$maxlifetime

Sessions that have not updated for the last maxlifetime seconds will be removed

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

isSupported()

static isSupported ( )

static

Test to see if the HandlerInterface is available

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

Implémente HandlerInterface.

Références class.

open()

open	(		$save_path,
			$session_id
	)

Initialize session

Paramètres

string	$save_path	The path where to store/retrieve the session
string	$session_id	The session id

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

read()

read

(

$session_id

)

Read session data

Paramètres

string

$session_id

The session id to read data for

Renvoie

string The session data

Depuis

2.0.0

Références $query.

write()

write	(		$session_id,
			$session_data
	)

Write session data

Paramètres

string	$session_id	The session id
string	$session_data	The encoded session data

Renvoie

boolean True on success, false otherwise

Depuis

2.0.0

Références $query, et ParameterType\INTEGER.

Documentation des champs

$db

$db

private

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

$gcCalled

$gcCalled = false

private

$gcLifetime

$gcLifetime

private

---

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

• DatabaseHandler.php