Difference between revisions of "JSession"
From Joomla! Documentation
m (JoomlaWikiBot moved page JSession/11.1 to API17:JSession without leaving a redirect: Robot: Moved page) |
m (preparing for archive only) |
||
(3 intermediate revisions by the same user not shown) | |||
Line 2: | Line 2: | ||
=={{JVer|11.1}} JSession== | =={{JVer|11.1}} JSession== | ||
===Description=== | ===Description=== | ||
− | + | ||
− | + | ||
− | |||
− | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::__construct | + | |[[API17:JSession::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::__destruct | + | |[[API17:JSession::__destruct|__destruct]] |
|Session object destructor. | |Session object destructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::clear | + | |[[API17:JSession::clear|clear]] |
|Unset data from the session store. | |Unset data from the session store. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::close | + | |[[API17:JSession::close|close]] |
|Writes session data and ends session. | |Writes session data and ends session. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::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 | + | |[[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 | + | |[[API17:JSession::get|get]] |
|Get data from the session store. | |Get data from the session store. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::getExpire | + | |[[API17:JSession::getExpire|getExpire]] |
|Get expiration time in minutes. | |Get expiration time in minutes. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::getId | + | |[[API17:JSession::getId|getId]] |
|Get session id. | |Get session id. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::getName | + | |[[API17:JSession::getName|getName]] |
|Get session name. | |Get session name. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::getState | + | |[[API17:JSession::getState|getState]] |
|Get current state of session. | |Get current state of session. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::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 | + | |[[API17:JSession::has|has]] |
|Check whether data exists in the session store. | |Check whether data exists in the session store. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::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 | + | |[[API17:JSession::isNew|isNew]] |
|Check whether this session is currently created. | |Check whether this session is currently created. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::restart | + | |[[API17:JSession::restart|restart]] |
|Restart an expired or locked session. | |Restart an expired or locked session. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSession::set | + | |[[API17:JSession::set|set]] |
|Set data into the session store. | |Set data into the session store. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JSession::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 | + | |[[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 | + | |[[API17:JSession::getStores|getStores]] |
|Get the session handlers. | |Get the session handlers. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_createId | + | |[[API17:JSession::_createId|_createId]] |
|Create a session id. | |Create a session id. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_createToken | + | |[[API17:JSession::_createToken|_createToken]] |
|Create a token-string. | |Create a token-string. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_setCookieParams | + | |[[API17:JSession::_setCookieParams|_setCookieParams]] |
|Set session cookie parameters. | |Set session cookie parameters. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_setCounter | + | |[[API17:JSession::_setCounter|_setCounter]] |
|Set counter of session usage. | |Set counter of session usage. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_setOptions | + | |[[API17:JSession::_setOptions|_setOptions]] |
|Set additional session options. | |Set additional session options. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_setTimers | + | |[[API17:JSession::_setTimers|_setTimers]] |
|Set the session timers. | |Set the session timers. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_start | + | |[[API17:JSession::_start|_start]] |
|Start a session. | |Start a session. | ||
|- | |- | ||
|protected | |protected | ||
− | |[[JSession::_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 | + | * '''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 | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Session|Session]] |
− | * [[JSession|Other versions of JSession]] | + | * [[API17:JSession|Other versions of JSession]] |
− | + | ||
− | + | ||
− | |||
− | |||
===User contributed notes=== | ===User contributed notes=== | ||
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JSession | category=JSession | ||
− | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
Line 149: | Line 145: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 22:38, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JSession[edit]
Description[edit]
Methods[edit]
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[edit]
jimport( 'joomla.session.session' );
See also[edit]
- JSession source code on BitBucket
- Subpackage Session
- Other versions of JSession
User contributed notes[edit]
Code Examples[edit]