Actions

API17

Difference between revisions of "JSession"

From Joomla! Documentation

m (User contributed notes: moving preparation)
m (moving preparation)
 
Line 14: Line 14:
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::__construct/11.1|__construct]]
+
|[[API17:JSession::__construct|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::__destruct/11.1|__destruct]]
+
|[[API17:JSession::__destruct|__destruct]]
 
|Session object destructor.  
 
|Session object destructor.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::clear/11.1|clear]]
+
|[[API17:JSession::clear|clear]]
 
|Unset data from the session store.  
 
|Unset data from the session store.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::close/11.1|close]]
+
|[[API17:JSession::close|close]]
 
|Writes session data and ends session.  
 
|Writes session data and ends session.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::destroy/11.1|destroy]]
+
|[[API17:JSession::destroy|destroy]]
 
|Frees all session variables and destroys all data registered to a session.  
 
|Frees all session variables and destroys all data registered to a session.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::fork/11.1|fork]]
+
|[[API17:JSession::fork|fork]]
 
|Create a new session and copy variables from the old one.  
 
|Create a new session and copy variables from the old one.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::get/11.1|get]]
+
|[[API17:JSession::get|get]]
 
|Get data from the session store.  
 
|Get data from the session store.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::getExpire/11.1|getExpire]]
+
|[[API17:JSession::getExpire|getExpire]]
 
|Get expiration time in minutes.  
 
|Get expiration time in minutes.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::getId/11.1|getId]]
+
|[[API17:JSession::getId|getId]]
 
|Get session id.  
 
|Get session id.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::getName/11.1|getName]]
+
|[[API17:JSession::getName|getName]]
 
|Get session name.  
 
|Get session name.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::getState/11.1|getState]]
+
|[[API17:JSession::getState|getState]]
 
|Get current state of session.  
 
|Get current state of session.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::getToken/11.1|getToken]]
+
|[[API17:JSession::getToken|getToken]]
 
|Get a session token, if a token isn't set yet one will be generated.  
 
|Get a session token, if a token isn't set yet one will be generated.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::has/11.1|has]]
+
|[[API17:JSession::has|has]]
 
|Check whether data exists in the session store.  
 
|Check whether data exists in the session store.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::hasToken/11.1|hasToken]]
+
|[[API17:JSession::hasToken|hasToken]]
 
|Method to determine if a token exists in the session.  
 
|Method to determine if a token exists in the session.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::isNew/11.1|isNew]]
+
|[[API17:JSession::isNew|isNew]]
 
|Check whether this session is currently created.  
 
|Check whether this session is currently created.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::restart/11.1|restart]]
+
|[[API17:JSession::restart|restart]]
 
|Restart an expired or locked session.  
 
|Restart an expired or locked session.  
 
|-
 
|-
 
|public  
 
|public  
|[[JSession::set/11.1|set]]
+
|[[API17:JSession::set|set]]
 
|Set data into the session store.  
 
|Set data into the session store.  
 
|-
 
|-
 
|public static  
 
|public static  
|[[JSession::getFormToken/11.1|getFormToken]]
+
|[[API17:JSession::getFormToken|getFormToken]]
 
|Method to determine a hash for anti-spoofing variable names.  
 
|Method to determine a hash for anti-spoofing variable names.  
 
|-
 
|-
 
|public static  
 
|public static  
|[[JSession::getInstance/11.1|getInstance]]
+
|[[API17:JSession::getInstance|getInstance]]
 
|Returns the global Session object, only creating it if it doesn't already exist.  
 
|Returns the global Session object, only creating it if it doesn't already exist.  
 
|-
 
|-
 
|public static  
 
|public static  
|[[JSession::getStores/11.1|getStores]]
+
|[[API17:JSession::getStores|getStores]]
 
|Get the session handlers.  
 
|Get the session handlers.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_createId/11.1|_createId]]
+
|[[API17:JSession::_createId|_createId]]
 
|Create a session id.  
 
|Create a session id.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_createToken/11.1|_createToken]]
+
|[[API17:JSession::_createToken|_createToken]]
 
|Create a token-string.  
 
|Create a token-string.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_setCookieParams/11.1|_setCookieParams]]
+
|[[API17:JSession::_setCookieParams|_setCookieParams]]
 
|Set session cookie parameters.  
 
|Set session cookie parameters.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_setCounter/11.1|_setCounter]]
+
|[[API17:JSession::_setCounter|_setCounter]]
 
|Set counter of session usage.  
 
|Set counter of session usage.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_setOptions/11.1|_setOptions]]
+
|[[API17:JSession::_setOptions|_setOptions]]
 
|Set additional session options.  
 
|Set additional session options.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_setTimers/11.1|_setTimers]]
+
|[[API17:JSession::_setTimers|_setTimers]]
 
|Set the session timers.  
 
|Set the session timers.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_start/11.1|_start]]
+
|[[API17:JSession::_start|_start]]
 
|Start a session.  
 
|Start a session.  
 
|-
 
|-
 
|protected  
 
|protected  
|[[JSession::_validate/11.1|_validate]]
+
|[[API17:JSession::_validate|_validate]]
 
|Do some checks for security reason.  
 
|Do some checks for security reason.  
 
|-
 
|-
 
|}
 
|}
 
* '''Defined in''' libraries/joomla/session/session.php
 
* '''Defined in''' libraries/joomla/session/session.php
* '''Extends''' [[JObject/11.1|JObject]]
+
* '''Extends''' [[API17:JObject|JObject]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.session.session' );</source>
 
<source lang="php">jimport( 'joomla.session.session' );</source>
 
===See also===
 
===See also===
 
* {{JVer|11.1}} '''JSession source code''' on [[jplatform:session/session.php|BitBucket]]
 
* {{JVer|11.1}} '''JSession source code''' on [[jplatform:session/session.php|BitBucket]]
* {{JVer|11.1}} Subpackage [[Subpackage Session/11.1|Session]]
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage Session|Session]]
* [[JSession|Other versions of JSession]]
+
* [[API17:JSession|Other versions of JSession]]
 
{{SeeAlso:JSession}}
 
{{SeeAlso:JSession}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">

Latest revision as of 20:27, 11 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JSession

Description

Description:JSession [Edit Descripton]

Methods

Visibility Method name Description
public __construct Constructor.
public __destruct Session object destructor.
public clear Unset data from the session store.
public close Writes session data and ends session.
public destroy Frees all session variables and destroys all data registered to a session.
public fork Create a new session and copy variables from the old one.
public get Get data from the session store.
public getExpire Get expiration time in minutes.
public getId Get session id.
public getName Get session name.
public getState Get current state of session.
public getToken Get a session token, if a token isn't set yet one will be generated.
public has Check whether data exists in the session store.
public hasToken Method to determine if a token exists in the session.
public isNew Check whether this session is currently created.
public restart Restart an expired or locked session.
public set Set data into the session store.
public static getFormToken Method to determine a hash for anti-spoofing variable names.
public static getInstance Returns the global Session object, only creating it if it doesn't already exist.
public static getStores Get the session handlers.
protected _createId Create a session id.
protected _createToken Create a token-string.
protected _setCookieParams Set session cookie parameters.
protected _setCounter Set counter of session usage.
protected _setOptions Set additional session options.
protected _setTimers Set the session timers.
protected _start Start a session.
protected _validate Do some checks for security reason.
  • Defined in libraries/joomla/session/session.php
  • Extends JObject

Importing

jimport( 'joomla.session.session' );

See also

  • Joomla 11.1 JSession source code on BitBucket
  • Joomla 11.1 Subpackage Session
  • Other versions of JSession

SeeAlso:JSession [Edit See Also]

User contributed notes

<CodeExamplesForm />