Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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 ()
 getState ()
 getExpire ()
 getToken ($forceNew=false)
 hasToken ($tCheck, $forceExpire=true)
 getName ()
 getId ()
 isNew ()
 get ($name, $default=null, $namespace= 'default')
 set ($name, $value=null, $namespace= 'default')
 has ($name, $namespace= 'default')
 clear ($name, $namespace= 'default')
 destroy ()
 restart ()
 fork ()
 close ()
- Fonctions membres publiques inherited from JObject
 __construct ($properties=null)
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)
 toString ()

Fonctions membres publiques statiques

static getInstance ($handler, $options)
static getFormToken ($forceNew=false)
static checkToken ($method= 'post')
static getStores ()

Fonctions membres protégées

 _start ()
 _createId ()
 _setCookieParams ()
 _createToken ($length=32)
 _setCounter ()
 _setTimers ()
 _setOptions (&$options)
 _validate ($restart=false)

Attributs protégés

 $_state = 'active'
 $_expire = 15
 $_store = null
 $_security = array('fix_browser')
 $_force_ssl = false
- Attributs protégés inherited from JObject
 $_errors = array()

Attributs protégés statiques

static $instance

Documentation des constructeurs et destructeur

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

Constructor

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

Références $options, et JSessionStorage\getInstance().

+ Voici le graphe d'appel pour cette fonction :

JSession::__destruct ( )

Session object destructor

Depuis:
11.1

Documentation des fonctions membres

JSession::_createId ( )
protected

Create a session id

Renvoie:
string Session ID
Depuis:
11.1

Références $id.

JSession::_createToken (   $length = 32)
protected

Create a token-string

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

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

JSession::_setCookieParams ( )
protected

Set session cookie parameters

Renvoie:
void
Depuis:
11.1

Références $config, et JFactory\getConfig().

+ Voici le graphe d'appel pour cette fonction :

JSession::_setCounter ( )
protected

Set counter of session usage

Renvoie:
boolean True on success
Depuis:
11.1

Références $counter.

JSession::_setOptions ( $options)
protected

Set additional session options

Paramètres:
array&$optionsList of parameter
Renvoie:
boolean True on success
Depuis:
11.1

Références $options.

JSession::_setTimers ( )
protected

Set the session timers

Renvoie:
boolean True on success
Depuis:
11.1
JSession::_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:
11.1

Références JRequest\getVar().

+ Voici le graphe d'appel pour cette fonction :

JSession::_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:
11.1

Références elseif, et null.

static JSession::checkToken (   $method = 'post')
static

Checks for a form token in the request.

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

Paramètres:
string$methodThe request method in which to look for the token key.
Renvoie:
boolean True if found and valid, false otherwise.
Depuis:
12.1

Références $app, JRoute\_(), JText\_(), JFactory\getApplication(), JFactory\getSession(), et JRequest\getVar().

Référencé par RedirectControllerLinks\activate(), UsersControllerUsers\activate(), MenusControllerItem\batch(), UsersControllerUser\batch(), ContactControllerContact\batch(), FinderControllerIndexer\batch(), WeblinksControllerWeblink\batch(), NewsfeedsControllerNewsfeed\batch(), BannersControllerBanner\batch(), ModulesControllerModule\batch(), CategoriesControllerCategory\batch(), ContentControllerArticle\batch(), UsersControllerMail\cancel(), MenusControllerItem\cancel(), TemplatesControllerSource\cancel(), LanguagesControllerOverride\cancel(), JControllerForm\cancel(), UsersControllerUsers\changeBlock(), CheckinController\checkin(), JControllerAdmin\checkin(), UsersControllerReset\complete(), UsersControllerReset\confirm(), TemplatesControllerTemplate\copy(), MediaControllerFolder\create(), JInstallationControllerSetup\database(), ContentControllerFeatured\delete(), MediaControllerFolder\delete(), LanguagesControllerOverrides\delete(), UsersControllerLevel\delete(), BannersControllerTracks\delete(), MenusControllerMenus\delete(), CacheController\delete(), CategoriesControllerCategories\delete(), JControllerAdmin\delete(), MediaControllerFile\delete(), JInstallationControllerSetup\detectFtpRoot(), TemplatesControllerStyles\duplicate(), ModulesControllerModules\duplicate(), ContactControllerContacts\featured(), ContentControllerArticles\featured(), JInstallationControllerSetup\filesystem(), InstallerControllerLanguages\find(), InstallerControllerUpdate\find(), InstallerControllerInstall\install(), JInstallationControllerSetup\loadSampleData(), UsersControllerUser\login(), LoginController\login(), LoginController\logout(), UsersControllerUser\logout(), FinderControllerIndexer\optimize(), InstallerControllerManage\publish(), JControllerAdmin\publish(), FinderControllerIndex\purge(), InstallerControllerLanguages\purge(), InstallerControllerUpdate\purge(), CacheController\purge(), CategoriesControllerCategories\rebuild(), MenusControllerItems\rebuild(), MenusControllerMenus\rebuild(), InstallerControllerManage\refresh(), UsersControllerRegistration\register(), UsersControllerUser\register(), UsersControllerRemind\remind(), UsersControllerUser\remind(), InstallerControllerManage\remove(), JInstallationControllerSetup\removeFolder(), ConfigControllerApplication\removeroot(), JControllerAdmin\reorder(), UsersControllerReset\request(), UsersControllerUser\resend(), SearchControllerSearches\reset(), MessagesControllerConfig\save(), FinderControllerFilter\save(), ConfigControllerComponent\save(), ConfigControllerApplication\save(), MenusControllerMenu\save(), LanguagesControllerOverride\save(), UsersControllerProfile\save(), MenusControllerItem\save(), TemplatesControllerSource\save(), JControllerForm\save(), JInstallationControllerSetup\saveconfig(), MenusControllerItems\saveorder(), CategoriesControllerCategories\saveorder(), JControllerAdmin\saveorder(), UsersControllerMail\send(), MailtoController\send(), LanguagesControllerInstalled\setDefault(), TemplatesControllerStyles\setDefault(), MenusControllerItems\setDefault(), JInstallationControllerSetup\setlanguage(), FinderControllerIndexer\start(), BannersControllerBanners\sticky_publish(), ContactControllerContact\submit(), TemplatesControllerStyles\unsetDefault(), InstallerControllerUpdate\update(), MediaControllerFile\upload(), JInstallationControllerSetup\verifyFtpSettings(), et ContentControllerArticle\vote().

+ Voici le graphe d'appel pour cette fonction :

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

Unset data from the session store

Paramètres:
string$nameName of variable
string$namespaceNamespace to use, default to 'default'
Renvoie:
mixed The value from session or NULL if not set
Depuis:
11.1

Références $name, et null.

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.

Renvoie:
void
Voir également:
session_write_close()
Depuis:
11.1
JSession::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:
11.1

Références $config, et JFactory\getConfig().

+ Voici le graphe d'appel pour cette fonction :

JSession::fork ( )

Create a new session and copy variables from the old one

Renvoie:
boolean $result true on success
Depuis:
11.1

Références $id.

JSession::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'
Renvoie:
mixed Value of a variable
Depuis:
11.1

Références $name, et null.

JSession::getExpire ( )

Get expiration time in minutes

Renvoie:
integer The session expiration time in minutes
Depuis:
11.1
static JSession::getFormToken (   $forceNew = false)
static

Method to determine a hash for anti-spoofing variable names

Paramètres:
boolean$forceNewIf true, force a new token to be created
Renvoie:
string Hashed var name
Depuis:
11.1

Références $user, JApplication\getHash(), JFactory\getSession(), et JFactory\getUser().

Référencé par JInstallationJsonResponse\__construct(), JRequest\checkToken(), JFormFieldModal_Article\getInput(), modLoggedHelper\getList(), JCache\getWorkarounds(), JAdministrator\render(), et JHtmlForm\token().

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de cette fonction :

JSession::getId ( )

Get session id

Renvoie:
string The session name
Depuis:
11.1

Références null.

static JSession::getInstance (   $handler,
  $options 
)
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.
Renvoie:
JSession The Session object.
Depuis:
11.1

Références $options.

Référencé par JFactory\createSession(), et JApplicationWeb\loadSession().

+ Voici le graphe des appelants de cette fonction :

JSession::getName ( )

Get session name

Renvoie:
string The session name
Depuis:
11.1

Références null.

JSession::getState ( )

Get current state of session

Renvoie:
string The session state
Depuis:
11.1
static JSession::getStores ( )
static

Get the session handlers

Renvoie:
array An array of available session handlers
Depuis:
11.1

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

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

+ Voici le graphe d'appel pour cette fonction :

+ Voici le graphe des appelants de 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$forceNewIf true, force a new token to be created
Renvoie:
string The session token
Depuis:
11.1

Références null.

JSession::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'
Renvoie:
boolean True if the variable exists
Depuis:
11.1

Références $name, et null.

JSession::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:
11.1
JSession::isNew ( )

Check whether this session is currently created

Renvoie:
boolean True on success.
Depuis:
11.1

Références $counter.

JSession::restart ( )

Restart an expired or locked session.

Renvoie:
boolean True on success
Voir également:
destroy
Depuis:
11.1

Références $id.

JSession::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'.
Renvoie:
mixed Old value of a variable.
Depuis:
11.1

Références $name, et null.


Documentation des données membres

JSession::$_expire = 15
protected
JSession::$_force_ssl = false
protected
JSession::$_security = array('fix_browser')
protected
JSession::$_state = 'active'
protected
JSession::$_store = null
protected
JSession::$instance
staticprotected

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