Référence de l'interface JSessionHandlerInterface

Graphe d'héritage de JSessionHandlerInterface:

Fonctions membres publiques
	start ()
	isStarted ()
	getId ()
	setId ($id)
	getName ()
	setName ($name)
	regenerate ($destroy=false, $lifetime=null)
	save ()
	clear ()

Description détaillée

Interface for managing HTTP sessions

Depuis

3.5

Obsolète:

4.0 The CMS' Session classes will be replaced with the joomla/session package

Documentation des fonctions membres

clear()

clear

(

)

Clear all session data in memory.

Renvoie

void

Depuis

3.5

Implémenté dans JSessionHandlerNative, et JSessionHandlerJoomla.

getId()

getId

(

)

Returns the session ID

Renvoie

string The session ID

Depuis

3.5

Implémenté dans JSessionHandlerNative.

getName()

getName

(

)

Returns the session name

Renvoie

mixed The session name.

Depuis

3.5

Implémenté dans JSessionHandlerNative.

isStarted()

isStarted

(

)

Checks if the session is started.

Renvoie

boolean True if started, false otherwise.

Depuis

3.5

Implémenté dans JSessionHandlerNative.

regenerate()

regenerate	(		$destroy = false,
			$lifetime = null
	)

Regenerates ID that represents this storage.

Note regenerate+destroy should not clear the session data in memory only delete the session data from persistent storage.

Paramètres

boolean	$destroy	Destroy session when regenerating?
integer	$lifetime	Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.

Renvoie

boolean True if session regenerated, false if error

Depuis

3.5

Implémenté dans JSessionHandlerNative.

save()

save

(

)

Force the session to be saved and closed.

This method must invoke session_write_close() unless this interface is used for a storage object design for unit or functional testing where a real PHP session would interfere with testing, in which case it should actually persist the session data if required.

Renvoie

void

Voir également

session_write_close()

Depuis

3.5

Exceptions

RuntimeException

If the session is saved without being started, or if the session is already closed.

Implémenté dans JSessionHandlerNative.

setId()

setId

(

$id

)

Sets the session ID

Paramètres

string

$id

The session ID

Renvoie

void

Depuis

3.5

Implémenté dans JSessionHandlerNative.

setName()

setName

(

$name

)

Sets the session name

Paramètres

string

$name

The name of the session

Renvoie

void

Depuis

3.5

Implémenté dans JSessionHandlerNative.

start()

start

(

)

Starts the session.

Renvoie

boolean True if started.

Depuis

3.5

Exceptions

RuntimeException

If something goes wrong starting the session.

Implémenté dans JSessionHandlerJoomla, et JSessionHandlerNative.

---

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

• joomla/session/handler/interface.php