Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe Session
+ Graphe d'héritage de Session:

Fonctions membres publiques

 __construct ($store='none', array $options=array())
 
 __get ($name)
 
 getState ()
 
 getExpire ()
 
 getToken ($forceNew=false)
 
 hasToken ($tCheck, $forceExpire=true)
 
 getIterator ()
 
 getName ()
 
 getId ()
 
 isActive ()
 
 isNew ()
 
 initialise (Input $input, DispatcherInterface $dispatcher=null)
 
 get ($name, $default=null, $namespace='default')
 
 set ($name, $value=null, $namespace='default')
 
 has ($name, $namespace='default')
 
 clear ($name, $namespace='default')
 
 start ()
 
 destroy ()
 
 restart ()
 
 fork ()
 
 close ()
 

Fonctions membres publiques statiques

static getInstance ($handler, array $options=array())
 
static getStores ()
 

Fonctions membres protégées

 _start ()
 
 setExpire ($expire)
 
 setState ($state)
 
 _setCookieParams ()
 
 _createToken ($length=32)
 
 createToken ($length=32)
 
 _setCounter ()
 
 setCounter ()
 
 _setTimers ()
 
 setTimers ()
 
 _setOptions (array $options)
 
 setOptions (array $options)
 
 _validate ($restart=false)
 
 validate ($restart=false)
 

Attributs protégés

 $state = 'inactive'
 
 $expire = 15
 
 $store = null
 
 $security = array('fix_browser')
 
 $force_ssl = false
 
 $cookie_domain
 
 $cookie_path
 
 $storeName
 

Attributs protégés statiques

static $instance
 

Attributs privés

 $input = null
 
 $dispatcher = null
 

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 (   $store = 'none',
array  $options = array() 
)

Constructor

Paramètres
string$storeThe type of storage for the session.
array$optionsOptional parameters
Depuis
1.0

Références $options, Session\$store, Session\_setCookieParams(), Session\_setOptions(), Storage\getInstance(), et Session\setState().

Documentation des fonctions membres

◆ __get()

__get (   $name)

Magic method to get read-only access to properties.

Paramètres
string$nameName of property to retrieve
Renvoie
mixed The value of the property
Depuis
1.0
Obsolète:
2.0 Use get methods for non-deprecated properties

Références $name.

◆ _createToken()

_createToken (   $length = 32)
protected

Create a token-string

Paramètres
integer$lengthLength of string
Renvoie
string Generated token
Depuis
1.0
Obsolète:
2.0 Use createToken instead

Références Session\createToken().

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

◆ _setCookieParams()

_setCookieParams ( )
protected

Set session cookie parameters

Renvoie
void
Depuis
1.0
Obsolète:
2.0

Références Session\$cookie_domain, et Session\$cookie_path.

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

◆ _setCounter()

_setCounter ( )
protected

Set counter of session usage

Renvoie
boolean True on success
Depuis
1.0
Obsolète:
2.0 Use setCounter instead

Références Session\setCounter().

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

◆ _setOptions()

_setOptions ( array  $options)
protected

Set additional session options

Paramètres
array$optionsList of parameter
Renvoie
boolean True on success
Depuis
1.0
Obsolète:
2.0 Use setOptions instead

Références Session\setOptions().

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

◆ _setTimers()

_setTimers ( )
protected

Set the session timers

Renvoie
boolean True on success
Depuis
1.0
Obsolète:
2.0 Use setTimers instead

Références Session\setTimers().

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

◆ _start()

_start ( )
protected

Start a session.

Creates a session (or resumes the current one based on the state of the session)

Renvoie
boolean true on success
Depuis
1.0
Obsolète:
2.0

Write and Close handlers are called after destructing objects since PHP 5.0.5. Thus destructors can use sessions but session handler can't use objects. So we are moving session closure before destructing objects.

Replace with session_register_shutdown() when dropping compatibility with PHP 5.3

Références Session\getState().

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

◆ _validate()

_validate (   $restart = false)
protected

Do some checks for security reason

  • timeout check (expire)
  • ip-fixiation
  • browser-fixiation

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

Paramètres
boolean$restartReactivate session
Renvoie
boolean True on success
Voir également
http://shiflett.org/articles/the-truth-about-sessions
Depuis
1.0
Obsolète:
2.0 Use validate instead

Références Session\validate().

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

◆ clear()

clear (   $name,
  $namespace = 'default' 
)

Unset data from the session store

Paramètres
string$nameName of variable
string$namespaceNamespace to use, default to 'default' {
Obsolète:
2.0 Namespace support will be removed.}
Renvoie
mixed The value from session or NULL if not set
Depuis
1.0

Références $name, $value, Session\getState(), et null.

◆ close()

close ( )

Writes session data and ends session

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

◆ createToken()

createToken (   $length = 32)
protected

Create a token-string

Paramètres
integer$lengthLength of string
Renvoie
string Generated token
Depuis
1.3.1

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

◆ 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 True on success
Voir également
session_destroy()
session_unset()
Depuis
1.0

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

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

◆ fork()

fork ( )

Create a new session and copy variables from the old one

Renvoie
boolean $result true on success
Depuis
1.0

Références Session\getState().

◆ get()

get (   $name,
  $default = null,
  $namespace = 'default' 
)

Get data from the session store

Paramètres
string$nameName of a variable
mixed$defaultDefault value of a variable if not set
string$namespaceNamespace to use, default to 'default' {
Obsolète:
2.0 Namespace support will be removed.}
Renvoie
mixed Value of a variable
Depuis
1.0

Références $default, $name, Session\getState(), et null.

◆ getExpire()

getExpire ( )

Get expiration time in minutes

Renvoie
integer The session expiration time in minutes
Depuis
1.0

Références Session\$expire.

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

◆ getId()

getId ( )

Get session id

Renvoie
string The session name
Depuis
1.0

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

◆ getInstance()

static getInstance (   $handler,
array  $options = array () 
)
static

Returns the global Session object, only creating it if it doesn't already exist.

Paramètres
string$handlerThe type of session handler.
array$optionsAn array of configuration options (for new sessions only).
Renvoie
Session The Session object.
Depuis
1.0
Obsolète:
2.0 A singleton object store will no longer be supported

Références $options.

◆ getIterator()

getIterator ( )

Retrieve an external iterator.

Renvoie
Return an ArrayIterator of $_SESSION.
Depuis
1.0

◆ getName()

getName ( )

Get session name

Renvoie
string The session name
Depuis
1.0

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

◆ getState()

getState ( )

◆ getStores()

static getStores ( )
static

Get the session handlers

Renvoie
array An array of available session handlers
Depuis
1.0
Obsolète:
2.0 The Storage class chain will be removed

Références $class, et $file.

◆ getToken()

getToken (   $forceNew = false)

Get a session token, if a token isn't set yet one will be generated.

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

Paramètres
boolean$forceNewIf true, force a new token to be created
Renvoie
string The session token
Depuis
1.0

Références Session\_createToken(), et null.

◆ has()

has (   $name,
  $namespace = 'default' 
)

Check whether data exists in the session store

Paramètres
string$nameName of variable
string$namespaceNamespace to use, default to 'default' {
Obsolète:
2.0 Namespace support will be removed.}
Renvoie
boolean True if the variable exists
Depuis
1.0

Références $name, Session\getState(), et null.

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

◆ hasToken()

hasToken (   $tCheck,
  $forceExpire = true 
)

Method to determine if a token exists in the session. If not the session will be set to expired

Paramètres
string$tCheckHashed token to be verified
boolean$forceExpireIf true, expires the session
Renvoie
boolean
Depuis
1.0

Références Session\setState().

◆ initialise()

initialise ( Input  $input,
DispatcherInterface  $dispatcher = null 
)

Check whether this session is currently created

Paramètres
Input$inputInput object for the session to use.
DispatcherInterface$dispatcherDispatcher object for the session to use.
Renvoie
void
Depuis
1.0
Obsolète:
2.0 In 2.0 the DispatcherInterface should be injected via the object constructor

Références Session\$dispatcher, et Session\$input.

◆ isActive()

isActive ( )

Shorthand to check if the session is active

Renvoie
boolean
Depuis
1.0

Références Session\getState().

◆ isNew()

isNew ( )

Check whether this session is currently created

Renvoie
boolean True on success.
Depuis
1.0

Références $counter.

◆ restart()

restart ( )

Restart an expired or locked session.

Renvoie
boolean True on success
Voir également
destroy
Depuis
1.0

Références Session\_setCounter(), Session\_start(), Session\_validate(), Session\destroy(), Session\getState(), et Session\setState().

◆ set()

set (   $name,
  $value = null,
  $namespace = 'default' 
)

Set data into the session store.

Paramètres
string$nameName of a variable.
mixed$valueValue of a variable.
string$namespaceNamespace to use, default to 'default' {
Obsolète:
2.0 Namespace support will be removed.}
Renvoie
mixed Old value of a variable.
Depuis
1.0

Références $name, $value, Session\getState(), et null.

◆ setCounter()

setCounter ( )
protected

Set counter of session usage

Renvoie
boolean True on success
Depuis
1.3.0

Références $counter.

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

◆ setExpire()

setExpire (   $expire)
protected

Set the session expiration

Paramètres
integer$expireMaximum age of unused session in minutes
Renvoie
$this
Depuis
1.3.0

Références Session\$expire.

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

◆ setOptions()

setOptions ( array  $options)
protected

Set additional session options

Paramètres
array$optionsList of parameter
Renvoie
boolean True on success
Depuis
1.3.0

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

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

◆ setState()

setState (   $state)
protected

Set the session state

Paramètres
string$stateInternal state
Renvoie
$this
Depuis
1.3.0

Références Session\$state.

Référencé par Session\__construct(), 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.3.0

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

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

◆ start()

start ( )

◆ validate()

validate (   $restart = false)
protected

Do some checks for security reason

  • timeout check (expire)
  • ip-fixiation
  • browser-fixiation

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

Paramètres
boolean$restartReactivate session
Renvoie
boolean True on success
Voir également
http://shiflett.org/articles/the-truth-about-sessions
Depuis
1.3.0

Références elseif, Session\getExpire(), null, et Session\setState().

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

Documentation des champs

◆ $cookie_domain

$cookie_domain
protected

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

◆ $cookie_path

$cookie_path
protected

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

◆ $dispatcher

$dispatcher = null
private

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

◆ $expire

$expire = 15
protected

◆ $force_ssl

$force_ssl = false
protected

◆ $input

$input = null
private

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

◆ $instance

$instance
staticprotected

◆ $security

$security = array('fix_browser')
protected

◆ $state

$state = 'inactive'
protected

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

◆ $store

$store = null
protected

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

◆ $storeName

$storeName
protected

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