API17

Difference between revisions of "JSession"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Layout updates)
Line 6: Line 6:
 
===Defined in===
 
===Defined in===
 
libraries/joomla/session/session.php
 
libraries/joomla/session/session.php
 +
* see source code in [[jplatform:session/session.php|BitBucket]]
 
===Subpackage===
 
===Subpackage===
 
[[Subpackage Session/11.1|Session]]
 
[[Subpackage Session/11.1|Session]]
Line 105: Line 106:
 
<source lang="php">jimport( 'joomla.session.session' );</source>
 
<source lang="php">jimport( 'joomla.session.session' );</source>
 
===See also===
 
===See also===
 +
* JSession source code in [[jplatform:session/session.php|BitBucket]]
 
* [[JSession|Other versions of this class]]
 
* [[JSession|Other versions of this class]]
 
{{SeeAlso:JSession}}
 
{{SeeAlso:JSession}}

Revision as of 18:01, 23 April 2011

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.

[Edit Descripton] Template:Description:JSession

Defined in[edit]

libraries/joomla/session/session.php

Subpackage[edit]

Session

Extends[edit]

JObject

Extended by[edit]

Methods[edit]

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

Importing[edit]

jimport( 'joomla.session.session' );

See also[edit]

Template:SeeAlso:JSession [Edit See Also]

Examples[edit]

<CodeExamplesForm />