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=[])
	get ($name, $default=null)
	set ($name, $value=null)
	has ($name)
	clear ()
Fonctions membres publiques hérités de Session
	__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 publiques statiques
static	checkToken ($method='post')
static	getFormToken ($forceNew=false)
static	getHandlers ()
static	getInstance ()

Membres hérités additionnels
Fonctions membres protégées hérités de Session
	createToken ()
	setCounter ()
	setExpire ($expire)
	setState ($state)
	setTimers ()
	setOptions (array $options)
	validate ($restart=false)
Attributs protégés hérités de Session
	$state = SessionState::INACTIVE
	$expire = 900
	$store
	$sessionValidators = []

Description détaillée

Class for managing HTTP sessions

Depuis

1.5

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, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

checkToken()

static checkToken (   $method = 'post' )

static

Checks for a form token in the request.

Use in conjunction with HTMLHelper::_('form.token') or JSession::getFormToken.

Paramètres

string

$method

The request method in which to look for the token key.

Renvoie

boolean True if found and valid, false otherwise.

Depuis

2.5.4

Références $app, Text\_(), Route\_(), Factory\getApplication(), et Joomla\Application\getFormToken().

Référencé par InstallController\ajax_upload(), IndexerController\batch(), BaseController\checkToken(), JSONController\checkValidToken(), ApiController\execute(), AjaxController\fetchAssociations(), IndexerController\optimize(), ModuleController\orderPosition(), SearchesController\reset(), et IndexerController\start().

clear()

clear

(

)

Clears all variables from the session store

Renvoie

void

Depuis

1.5

Implémente SessionInterface.

Références $name, et Joomla\Database\Query\clear().

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.5

Implémente SessionInterface.

Références $default, $name, Symfony\Contracts\Service\get(), et Symfony\Contracts\Service\has().

getFormToken()

static getFormToken (   $forceNew = false )

static

Method to determine a hash for anti-spoofing variable names

Paramètres

boolean

$forceNew

If true, force a new token to be created

Renvoie

string Hashed var name

Depuis

1.6

Références $user, Factory\getApplication(), ApplicationHelper\getHash(), et Factory\getUser().

Référencé par JsonResponse\__construct(), HtmlView\addToolbar(), DraggableList\draggable(), Joomlaupdate\getCoreUpdateNotification(), AssociationField\getInput(), ContenthistoryField\getLayoutData(), ModuleorderField\getLayoutData(), LoggedHelper\getList(), HistoryController\getRedirectToListAppend(), Cache\getWorkarounds(), HistoryController\keep(), UserController\menulogout(), Joomla\Plugin\Editors\TinyMCE\PluginTraits\onDisplay(), AdministratorApplication\render(), JSONController\sendJsonResponse(), et Form\token().

getHandlers()

static getHandlers ( )

static

Get the available session handlers

Renvoie

array An array of available session handlers

Depuis

4.0.0

Références $class, et JPATH_LIBRARIES.

Référencé par SessionhandlerField\getOptions().

getInstance()

static getInstance ( )

static

Returns the global session object.

Renvoie

static The Session object.

Depuis

1.5

Obsolète:

5.0 Load the session service from the dependency injection container or via $app->getSession()

Références Factory\getApplication().

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.5

Implémente SessionInterface.

Références $name, et Symfony\Contracts\Service\has().

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.5

Implémente SessionInterface.

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

---

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

• src/Session/Session.php