Référence de la classe Session

Graphe d'héritage de Session:

Fonctions membres publiques
	__construct (StorageInterface $store=null, DispatcherInterface $dispatcher=null, array $options=[])
	addValidator (ValidatorInterface $validator)
	getExpire ()
	getState ()
	getToken ($forceNew=false)
	hasToken ($token, $forceExpire=true)
	getIterator ()
	getName ()
	setName (string $name)
	getId ()
	setId (string $id)
	isActive ()
	isNew ()
	isStarted ()
	get ($name, $default=null)
	set ($name, $value=null)
	has ($name)
	remove (string $name)
	clear ()
	all ()
	start ()
	destroy ()
	restart ()
	fork ($destroy=false)
	close ()
	gc ()
	abort ()
Fonctions membres publiques hérités de SessionInterface
	fork ()
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres protégées
	createToken ()
	setCounter ()
	setExpire ($expire)
	setState ($state)
	setTimers ()
	setOptions (array $options)
	validate ($restart=false)

Attributs protégés
	$state = SessionState::INACTIVE
	$expire = 900
	$store
	$sessionValidators = []

Description détaillée

Class for managing HTTP sessions

Provides access to session-state values as well as session-level settings and lifetime management methods. Based on the standard PHP session handling mechanism it provides more advanced features such as expire timeouts.

Depuis

1.0

Documentation des constructeurs et destructeur

__construct()

__construct	(	StorageInterface	$store = null,
		DispatcherInterface	$dispatcher = null,
		array	$options = []
	)

Constructor

Paramètres

StorageInterface	$store	A StorageInterface implementation.
DispatcherInterface	$dispatcher	DispatcherInterface for the session to use.
array	$options	Optional parameters. Supported keys include: name: The session name id: The session ID expire: The session lifetime in seconds

Depuis

1.0

Références $options, Session\$store, SessionState\INACTIVE, DispatcherAwareInterface\setDispatcher(), Session\setOptions(), et Session\setState().

Documentation des fonctions membres

abort()

abort

(

)

Aborts the current session

Renvoie

boolean

Voir également

session_abort()

Depuis

2.0.0

Implémente SessionInterface.

Références Session\isActive().

addValidator()

addValidator

(

ValidatorInterface

$validator

)

Adds a validator to the session

Paramètres

ValidatorInterface

$validator

The session validator

Renvoie

void

Depuis

2.0.0

all()

all

(

)

Retrieves all variables from the session store

Renvoie

array

Depuis

2.0.0

Implémente SessionInterface.

Références Session\isActive(), et Session\start().

Référencé par Session\getIterator(), et Session\restart().

clear()

clear

(

)

Clears all variables from the session store

Renvoie

void

Depuis

1.0

Implémente SessionInterface.

Références Session\isActive(), et Session\start().

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

close()

close

(

)

Writes session data and ends session

Session data is usually stored after your script terminated without the need to call Session::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

1.0

Implémente SessionInterface.

Références SessionState\CLOSED, et Session\setState().

createToken()

createToken ( )

protected

Create a token string

Renvoie

string

Depuis

1.3.1

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

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.

Renvoie

boolean

Voir également

session_destroy()

session_unset()

Depuis

1.0

Implémente SessionInterface.

Références Session\clear(), SessionState\DESTROYED, SessionInterface\fork(), Session\getState(), et Session\setState().

Référencé par Session\restart(), et Session\start().

fork()

fork

(

$destroy = false

)

Create a new session and copy variables from the old one

Paramètres

boolean

$destroy

Whether to delete the old session or leave it to garbage collection.

Renvoie

boolean True on success

Depuis

1.0

Références $result, et Session\setTimers().

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émente SessionInterface.

Références Session\isActive(), et Session\start().

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

1.0

Implémente SessionInterface.

Références $default, $name, Session\isActive(), et Session\start().

getExpire()

getExpire

(

)

Get expiration time in seconds

Renvoie

integer The session expiration time in seconds

Depuis

1.0

Implémente SessionInterface.

Références Session\$expire.

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

getId()

getId

(

)

Get session id

Renvoie

string The session id

Depuis

1.0

Implémente SessionInterface.

getIterator()

getIterator

(

)

Retrieve an external iterator.

Renvoie

Return an ArrayIterator of $_SESSION.

Depuis

1.0

Références Session\all().

getName()

getName

(

)

Get session name

Renvoie

string The session name

Depuis

1.0

Implémente SessionInterface.

Référencé par JoomlaStorage\clear(), et JoomlaStorage\start().

getState()

getState

(

)

Get current state of session

Renvoie

string The session state

Depuis

1.0

Références Session\$state.

Référencé par Session\destroy(), Session\isActive(), Session\restart(), et Session\start().

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

1.0

Implémente SessionInterface.

Références Session\createToken(), et Session\has().

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

1.0

Implémente SessionInterface.

Références $name, Session\isActive(), et Session\start().

Référencé par Session\getToken(), et Session\setTimers().

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

1.0

Implémente SessionInterface.

Références $result, SessionState\EXPIRED, et Session\setState().

isActive()

isActive

(

)

Check if the session is active

Renvoie

boolean

Depuis

1.0

Implémente SessionInterface.

Références SessionState\ACTIVE, et Session\getState().

Référencé par JoomlaStorage\__construct(), Session\abort(), Session\all(), Session\clear(), Session\gc(), Session\get(), Session\has(), Session\remove(), Session\set(), et JoomlaStorage\setCookieParams().

isNew()

isNew

(

)

Check whether this session is currently created

Renvoie

boolean

Depuis

1.0

Implémente SessionInterface.

isStarted()

isStarted

(

)

Check if the session is started

Renvoie

boolean

Depuis

2.0.0

Implémente SessionInterface.

Référencé par JoomlaStorage\get(), JoomlaStorage\has(), JoomlaStorage\remove(), JoomlaStorage\set(), et Session\start().

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émente SessionInterface.

Références $name, Session\isActive(), et Session\start().

restart()

restart

(

)

Restart an expired or locked session.

Renvoie

boolean True on success

Voir également

destroy

Depuis

1.0

Implémente SessionInterface.

Références $data, $key, $this, $value, SessionState\ACTIVE, Session\all(), class, Session\destroy(), SessionState\DESTROYED, Session\getState(), SessionEvents\RESTART, Session\setCounter(), Session\setState(), Session\setTimers(), et Session\validate().

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

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

1.0

Implémente SessionInterface.

Références $name, $value, Session\isActive(), et Session\start().

setCounter()

setCounter ( )

protected

Set counter of session usage

Renvoie

boolean True on success

Depuis

1.0

Référencé par Session\restart(), et Session\start().

setExpire()

setExpire (   $expire )

protected

Set the session expiration

Paramètres

integer

$expire

Maximum age of unused session in seconds

Renvoie

$this

Depuis

1.3.0

Références Session\$expire, et $this.

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

setId()

setId

(

string

$id

)

Set the session ID

Paramètres

string

$id

The session ID

Renvoie

$this

Depuis

2.0.0

Implémente SessionInterface.

Références $id, et $this.

Référencé par Session\setOptions(), et JoomlaStorage\start().

setName()

setName

(

string

$name

)

Set the session name

Paramètres

string

$name

The session name

Renvoie

$this

Depuis

2.0.0

Implémente SessionInterface.

Références $name, et $this.

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

setOptions()

setOptions ( array  $options )

protected

Set additional session options

Paramètres

array

$options

List of parameter

Renvoie

boolean True on success

Depuis

1.0

Références $options, Session\getExpire(), Session\setExpire(), Session\setId(), et Session\setName().

Référencé par JoomlaStorage\__construct(), et Session\__construct().

setState()

setState (   $state )

protected

Set the session state

Paramètres

string

$state

Internal state

Renvoie

$this

Depuis

1.3.0

Références Session\$state, et $this.

Référencé par Session\__construct(), Session\close(), Session\destroy(), Session\hasToken(), Session\restart(), Session\start(), et Session\validate().

setTimers()

setTimers ( )

protected

Set the session timers

Renvoie

boolean True on success

Depuis

1.0

Références $start, et Session\has().

Référencé par Session\fork(), Session\restart(), et Session\start().

start()

start

(

)

Start a session.

Renvoie

void

Depuis

1.0

Implémente SessionInterface.

Références $this, SessionState\ACTIVE, class, Session\destroy(), SessionState\EXPIRED, Session\getState(), Session\isStarted(), Session\restart(), Session\setCounter(), Session\setState(), Session\setTimers(), SessionEvents\START, et Session\validate().

Référencé par Session\all(), Session\clear(), Session\gc(), JoomlaStorage\get(), Session\get(), JoomlaStorage\has(), Session\has(), JoomlaStorage\remove(), Session\remove(), JoomlaStorage\set(), et Session\set().

validate()

validate (   $restart = false )

protected

Do some checks for security reasons

If one check fails, session data has to be cleaned.

Paramètres

boolean

$restart

Reactivate session

Renvoie

boolean True on success

Voir également

http://shiflett.org/articles/the-truth-about-sessions

Depuis

1.0

Références SessionState\ACTIVE, SessionState\ERROR, SessionState\EXPIRED, et Session\setState().

Référencé par Session\restart(), et Session\start().

Documentation des champs

$expire

$expire = 900

protected

Référencé par Session\getExpire(), et Session\setExpire().

$sessionValidators

$sessionValidators = []

protected

$state

$state = SessionState::INACTIVE

protected

Référencé par Session\getState(), et Session\setState().

$store

$store

protected

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

---

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

• vendor/joomla/session/src/Session.php