Référence de la classe Session

Graphe d'héritage de Session:

Fonctions membres publiques
	__construct ($store='none', array $options=array(), \JSessionHandlerInterface $handlerInterface=null)
	__get ($name)
	getState ()
	getExpire ()
	getToken ($forceNew=false)
	hasToken ($tCheck, $forceExpire=true)
	getIterator ()
	getName ()
	getId ()
	getData ()
	isActive ()
	isNew ()
	initialise (Input $input, \JEventDispatcher $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 ()
	gc ()
	setHandler (\JSessionHandlerInterface $handler)

Fonctions membres publiques statiques
static	getInstance ($store, $options, \JSessionHandlerInterface $handlerInterface=null)
static	getFormToken ($forceNew=false)
static	checkToken ($method='post')
static	getStores ()

Fonctions membres protégées
	_start ()
	_createToken ($length=32)
	_setCounter ()
	_setTimers ()
	_setOptions (array $options)
	_validate ($restart=false)

Attributs protégés
	$_state = 'inactive'
	$_expire = 900
	$_store = null
	$_security = array('fix_browser')
	$storeName
	$_handler = null
	$data

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

Documentation des constructeurs et destructeur

__construct()

__construct	(		$store = 'none',
		array	$options = array(),
		\JSessionHandlerInterface	$handlerInterface = null
	)

Constructor

Paramètres

string	$store	The type of storage for the session.
array	$options	Optional parameters
\JSessionHandlerInterface	$handlerInterface	The session handler

Depuis

1.7.0

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

Documentation des fonctions membres

__get()

__get

(

$name

)

Magic method to get read-only access to properties.

Paramètres

string

$name

Name of property to retrieve

Renvoie

mixed The value of the property

Depuis

3.0.1

Références $name.

_createToken()

_createToken (   $length = 32 )

protected

Create a token-string

Paramètres

integer

$length

Length of string

Renvoie

string Generated token

Depuis

1.7.0

Références UserHelper\genRandomPassword().

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

_setCounter()

_setCounter ( )

protected

Set counter of session usage

Renvoie

boolean True on success

Depuis

1.7.0

Références $counter.

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

_setOptions()

_setOptions ( array  $options )

protected

Set additional session options

Paramètres

array

$options

List of parameter

Renvoie

boolean True on success

Depuis

1.7.0

Références $options.

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

_setTimers()

_setTimers ( )

protected

Set the session timers

Renvoie

boolean True on success

Depuis

1.7.0

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

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

Finally, empty the __default key since we no longer need it. Don't unset it completely, we need this for the administrator/components/com_admin/script.php to detect upgraded sessions and perform a full session cleanup.

Références Session\$data, et null.

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

$restart

Reactivate session

Renvoie

boolean True on success

1.7.0

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

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

checkToken()

static checkToken (   $method = 'post' )

static

Checks for a form token in the request.

Use in conjunction with ::_('form.token') or Session::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

3.0.0

Références $app.

clear()

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

Unset data from the session store

Paramètres

string	$name	Name of variable
string	$namespace	Namespace to use, default to 'default'

Renvoie

mixed The value from session or NULL if not set

Depuis

1.7.0

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

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

Depuis

1.7.0

destroy()

destroy

(

)

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

This method resets the data pointer and destroys all of the data associated with the current session in its storage. It forces a 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.7.0

Références Session\getState().

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

fork()

fork

(

)

Create a new session and copy variables from the old one

Renvoie

boolean $result true on success

Depuis

1.7.0

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

gc()

gc

(

)

Delete expired session data

Renvoie

boolean True on success, false otherwise.

Depuis

3.8.6

Références Session\getExpire().

get()

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

Get data from the session store

Paramètres

string	$name	Name of a variable
mixed	$default	Default value of a variable if not set
string	$namespace	Namespace to use, default to 'default'

Renvoie

mixed Value of a variable

Depuis

1.7.0

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

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

getData()

getData

(

)

Returns a clone of the internal data pointer

Renvoie

Références Session\$data.

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

getExpire()

getExpire

(

)

Get expiration time in seconds

Renvoie

integer The session expiration time in seconds

Depuis

1.7.0

Références Session\$_expire.

Référencé par Session\_validate(), et Session\gc().

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

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

Référencé par ContenthistoryField\getLayoutData(), et ModuleorderField\getLayoutData().

getId()

getId

(

)

Get session id

Renvoie

string The session id

Depuis

1.7.0

Références Session\getState().

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

getInstance()

static getInstance (   $store,   $options, \JSessionHandlerInterface  $handlerInterface = null  )

static

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

Paramètres

string	$store	The type of storage for the session.
array	$options	An array of configuration options.
\JSessionHandlerInterface	$handlerInterface	The session handler

Renvoie

Session The Session object.

Depuis

1.7.0

Références $options.

Référencé par Factory\createSession().

getIterator()

getIterator

(

)

Retrieve an external iterator.

Renvoie

Depuis

3.0.1

Références Session\getData().

getName()

getName

(

)

Get session name

Renvoie

string The session name

Depuis

1.7.0

Références Session\getState().

getState()

getState

(

)

Get current state of session

Renvoie

string The session state

Depuis

1.7.0

Références Session\$_state.

Référencé par Session\clear(), Session\destroy(), Session\fork(), Session\get(), Session\getId(), Session\getName(), Session\has(), Session\isActive(), Session\restart(), Session\set(), et Session\start().

getStores()

static getStores ( )

static

Get the session handlers

Renvoie

array An array of available session handlers

Depuis

1.7.0

$file

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

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

$forceNew

If true, force a new token to be created

Renvoie

string The session token

Depuis

1.7.0

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

has()

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

Check whether data exists in the session store

Paramètres

string	$name	Name of variable
string	$namespace	Namespace to use, default to 'default'

Renvoie

boolean True if the variable exists

Depuis

1.7.0

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

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	$tCheck	Hashed token to be verified
boolean	$forceExpire	If true, expires the session

Renvoie

boolean

Depuis

1.7.0

initialise()

initialise	(	Input	$input,
		\JEventDispatcher	$dispatcher = null
	)

Check whether this session is currently created

Paramètres

Input	$input	Input object for the session to use.
\JEventDispatcher	$dispatcher	Dispatcher object for the session to use.

Renvoie

void

Depuis

3.0.1

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

isActive()

isActive

(

)

Shorthand to check if the session is active

Renvoie

boolean

Depuis

3.0.1

Références Session\getState().

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

isNew()

isNew

(

)

Check whether this session is currently created

Renvoie

boolean True on success.

Depuis

1.7.0

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

restart()

restart

(

)

Restart an expired or locked session.

Renvoie

boolean True on success

Voir également

Session::destroy()

Depuis

1.7.0

Destroy the session if it's not valid - we can't restart the session here unlike in the start method else we risk recursion.

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

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

set()

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

Set data into the session store.

Paramètres

string	$name	Name of a variable.
mixed	$value	Value of a variable.
string	$namespace	Namespace to use, default to 'default'.

Renvoie

mixed Old value of a variable.

Depuis

1.7.0

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

setHandler()

setHandler

(

\JSessionHandlerInterface

$handler

)

Set the session handler

Paramètres

\JSessionHandlerInterface

$handler

The session handler

Renvoie

void

start()

start

(

)

Start a session.

Renvoie

void

Depuis

3.0.1

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

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

Documentation des champs

$_dispatcher

$_dispatcher = null

private

$_expire

$_expire = 900

protected

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

$_handler

$_handler = null

protected

$_input

$_input = null

private

$_security

$_security = array('fix_browser')

protected

$_state

$_state = 'inactive'

protected

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

$_store

$_store = null

protected

$data

$data

protected

Référencé par Session\_start(), et Session\getData().

$instance

$instance

staticprotected

$storeName

$storeName

protected

---

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

• src/Session/Session.php