Référence de la classe JSession

Graphe d'héritage de JSession:

Graphe de collaboration de JSession:

Liste de tous les membres

Fonctions membres publiques

• __construct ($store= 'none', $options=array())
• __destruct ()
• & getInstance ($handler, $options)
• getState ()
• getExpire ()
• getToken ($forceNew=false)
• getName ()
• getId ()
• getStores ()
• isNew ()
• set ($name, $value, $namespace= 'default')
• has ($name, $namespace= 'default')
• clear ($name, $namespace= 'default')
• _start ()
• restart ()
• fork ()
• close ()
• _setCookieParams ()
• _createToken ($length=32)
• _setCounter ()
• _setTimers ()
• _setOptions (&$options)
• _validate ($restart=false)

Fonctions membres publiques statiques

• hasToken ($tCheck, $forceExpire=true)
• & get ($name, $default=null, $namespace= 'default')
• destroy ()
• _createId ()

Attributs publics

• $_state = 'active'
• $_expire = 15
• $_store = null
• $_security = array( 'fix_browser' )
• $_force_ssl = false

---

Documentation des constructeurs et destructeur

JSession::__construct	(	$	store = 'none',
		$	options = array()
	)

Constructor

protected

Paramètres:

string	$storage
array	$options	optional parameters

Références JSessionStorage::getInstance().

Voici le graphe d'appel pour cette fonction :

JSession::__destruct

(

)

Session object destructor

private

Depuis:

1.5

---

Documentation des fonctions membres

JSession::_createId

(

)

[static]

Create a session id

private

Renvoie:

string Session ID

Références $id.

JSession::_createToken

(

$

length = 32

)

Create a token-string

protected

Paramètres:

int

$length

lenght of string

Renvoie:

string $id generated token

Références $i.

JSession::_setCookieParams

(

)

Set session cookie parameters

private

JSession::_setCounter

(

)

Set counter of session usage

protected

Renvoie:

boolean $result true on success

JSession::_setOptions

(

&$

options

)

set additional session options

protected

Paramètres:

array

$options

list of parameter

Renvoie:

boolean $result true on success

JSession::_setTimers

(

)

Set the session timers

protected

Renvoie:

boolean $result true on success

Références $start.

JSession::_start

(

)

Start a session

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

private

Renvoie:

boolean $result true on success

JSession::_validate

(

$

restart = false

)

Do some checks for security reason

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

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

protected

Paramètres:

boolean

$restart

reactivate session

Renvoie:

boolean $result true on success

Voir également:

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

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

Unset data from the session store

public

Paramètres:

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

Renvoie:

mixed $value the value from session or NULL if not set

Références $name.

JSession::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.

public

Voir également:

session_write_close()

JSession::destroy

(

)

[static]

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.

public

Renvoie:

void

Voir également:

session_unset()

session_destroy()

JSession::fork

(

)

Create a new session and copy variables from the old one

public

Renvoie:

boolean $result true on success

& JSession::get	(	$	name,
		$	default = null,
		$	namespace = 'default'
	)		[static]

Get data from the session store

public

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

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

JSession::getExpire

(

)

Get expiration time in minutes

public

Renvoie:

integer The session expiration time in minutes

JSession::getId

(

)

Get session id

public

Renvoie:

string The session name

& JSession::getInstance	(	$	handler,
		$	options
	)

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

This method must be invoked as:

  $session = &JSession::getInstance();

public

Renvoie:

JSession The Session object.

Depuis:

1.5

Référencé par JFactory::_createSession().

Voici le graphe d'appel pour cette fonction :

JSession::getName

(

)

Get session name

public

Renvoie:

string The session name

JSession::getState

(

)

Get current state of session

public

Renvoie:

string The session state

JSession::getStores

(

)

Get the session handlers

public

Renvoie:

array An array of available session handlers

Références $class, $name, JFolder::files(), et jimport().

Référencé par ConfigControllerApplication::showConfig().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JSession::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 public

Renvoie:

string The session token

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

Check wheter data exists in the session store

public

Paramètres:

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

Renvoie:

boolean $result true if the variable exists

JSession::hasToken	(	$	tCheck,
		$	forceExpire = true
	)		[static]

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

Paramètres:

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

Depuis:

1.5

JSession::isNew

(

)

Check whether this session is currently created

public

Renvoie:

boolean $result true on success

JSession::restart

(

)

restart an expired or locked session

public

Renvoie:

boolean $result true on success

Voir également:

destroy

Références $id.

JSession::set	(	$	name,
		$	value,
		$	namespace = 'default'
	)

Set data into the session store

public

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

Références $name.

---

Documentation des données membres

JSession::$_expire = 15

JSession::$_force_ssl = false

JSession::$_security = array( 'fix_browser' )

JSession::$_state = 'active'

JSession::$_store = null

---

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

• libraries/joomla/session/session.php