Référence de l'interface SessionInterface

Graphe d'héritage de SessionInterface:

Fonctions membres publiques
	getExpire ()
	getName ()
	setName (string $name)
	getId ()
	setId (string $id)
	isActive ()
	isNew ()
	isStarted ()
	getToken ($forceNew=false)
	hasToken ($token, $forceExpire=true)
	get ($name, $default=null)
	set ($name, $value=null)
	has ($name)
	remove (string $name)
	clear ()
	all ()
	start ()
	destroy ()
	restart ()
	fork ()
	close ()
	gc ()
	abort ()

Description détaillée

Interface defining a Joomla! Session object

Depuis

2.0.0

Documentation des fonctions membres

abort()

abort

(

)

Aborts the current session

Renvoie

boolean

Voir également

session_abort()

Depuis

2.0.0

Implémenté dans Session.

all()

all

(

)

Retrieves all variables from the session store

Renvoie

array

Depuis

2.0.0

Implémenté dans Session.

clear()

clear

(

)

Clears all variables from the session store

Renvoie

void

Depuis

2.0.0

Implémenté dans Session, et Session.

close()

close

(

)

Writes session data and ends session

Session data is usually stored after your script terminated without the need to call SessionInterface::close(), but as session data is locked to prevent concurrent writes only one script may operate on a session at any time. When using framesets together with sessions you will experience the frames loading one by one due to this locking. You can reduce the time needed to load all the frames by ending the session as soon as all changes to session variables are done.

Renvoie

void

Voir également

session_write_close()

Depuis

2.0.0

Implémenté dans Session.

destroy()

destroy

(

)

Frees all session variables and destroys all data registered to a session

This method resets the $_SESSION variable and destroys all of the data associated with the current session in its storage (file or DB). It forces new session to be started after this method is called. It does not unset the session cookie.

Renvoie

boolean

Voir également

session_destroy()

session_unset()

Depuis

2.0.0

Implémenté dans Session.

fork()

fork

(

)

Create a new session and copy variables from the old one

Renvoie

boolean

Depuis

2.0.0

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

gc()

gc

(

)

Perform session data garbage collection

Renvoie

integer|boolean Number of deleted sessions on success or boolean false on failure or if the function is unsupported

Voir également

session_gc()

Depuis

2.0.0

Implémenté dans Session.

get()

get	(		$name,
			$default = null
	)

Get data from the session store

Paramètres

string	$name	Name of a variable
mixed	$default	Default value of a variable if not set

Renvoie

mixed Value of a variable

Depuis

2.0.0

Implémenté dans Session, et Session.

Référencé par MetadataManager\createSessionRecord().

getExpire()

getExpire

(

)

Get expiration time in seconds

Renvoie

integer The session expiration time in seconds

Depuis

2.0.0

Implémenté dans Session.

getId()

getId

(

)

Get the session ID

Renvoie

string The session ID

Depuis

2.0.0

Implémenté dans Session.

Référencé par MetadataManager\createOrUpdateRecord(), MetadataManager\createRecordIfNonExisting(), MetadataManager\createSessionRecord(), et MetadataManager\updateSessionRecord().

getName()

getName

(

)

Get the session name

Renvoie

string The session name

Depuis

2.0.0

Implémenté dans Session.

getToken()

getToken

(

$forceNew = false

)

Get a session token.

Tokens are used to secure forms from spamming attacks. Once a token has been generated the system will check the request to see if it is present, if not it will invalidate the session.

Paramètres

boolean

$forceNew

If true, forces a new token to be created

Renvoie

string

Depuis

2.0.0

Implémenté dans Session.

has()

has

(

$name

)

Check whether data exists in the session store

Paramètres

string

$name

Name of variable

Renvoie

boolean True if the variable exists

Depuis

2.0.0

Implémenté dans Session, et Session.

hasToken()

hasToken	(		$token,
			$forceExpire = true
	)

Check if the session has the given token.

Paramètres

string	$token	Hashed token to be verified
boolean	$forceExpire	If true, expires the session

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Session.

isActive()

isActive

(

)

Check if the session is active

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Session.

isNew()

isNew

(

)

Check whether this session is newly created

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Session.

Référencé par MetadataManager\createSessionRecord().

isStarted()

isStarted

(

)

Check if the session is started

Renvoie

boolean

Depuis

2.0.0

Implémenté dans Session.

remove()

remove

(

string

$name

)

Unset a variable from the session store

Paramètres

string

$name

Name of variable

Renvoie

mixed The value from session or NULL if not set

Depuis

2.0.0

Implémenté dans Session.

restart()

restart

(

)

Restart an expired or locked session

Renvoie

boolean True on success

Voir également

destroy

Depuis

2.0.0

Implémenté dans Session.

set()

set	(		$name,
			$value = null
	)

Set data into the session store

Paramètres

string	$name	Name of a variable.
mixed	$value	Value of a variable.

Renvoie

mixed Old value of a variable.

Depuis

2.0.0

Implémenté dans Session, et Session.

setId()

setId

(

string

$id

)

Set the session ID

Paramètres

string

$id

The session ID

Renvoie

$this

Depuis

2.0.0

Implémenté dans Session.

setName()

setName

(

string

$name

)

Set the session name

Paramètres

string

$name

The session name

Renvoie

$this

Depuis

2.0.0

Implémenté dans Session.

start()

start

(

)

Start a session

Renvoie

void

Depuis

2.0.0

Implémenté dans Session.

---

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

• SessionInterface.php