API17

JSessionStorage: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Bots
18,905 edits
Bulk upload by Doxiki2
 
m preparing for archive only
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
<span class="editsection" style="font-size:76%;">
=={{JVer|11.1}} JSessionStorage==
<nowiki>[</nowiki>[[Description:JSessionStorage|Edit Descripton]]<nowiki>]</nowiki>
===Description===
</span>
 
{{Description:JSessionStorage}}
 
===Defined in===
libraries/joomla/session/storage.php
===Subpackage===
[[Subpackage Session/11.1|Session]]
===Extends===
[[JObject/11.1|JObject]]
===Extended by===
* [[JSessionStorageApc/11.1|JSessionStorageApc]]
* [[JSessionStorageDatabase/11.1|JSessionStorageDatabase]]
* [[JSessionStorageEaccelerator/11.1|JSessionStorageEaccelerator]]
* [[JSessionStorageMemcache/11.1|JSessionStorageMemcache]]
* [[JSessionStorageNone/11.1|JSessionStorageNone]]
* [[JSessionStorageWincache/11.1|JSessionStorageWincache]]
* [[JSessionStorageXcache/11.1|JSessionStorageXcache]]
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|[[JSessionStorage::__construct/11.1|__construct]]
|public
|[[API17:JSessionStorage::__construct|__construct]]
|Constructor.  
|Constructor.  
|-
|-
|[[JSessionStorage::close/11.1|close]]
|public
|[[API17:JSessionStorage::close|close]]
|Close the SessionHandler backend.  
|Close the SessionHandler backend.  
|-
|-
|[[JSessionStorage::destroy/11.1|destroy]]
|public
|[[API17:JSessionStorage::destroy|destroy]]
|Destroy the data for a particular session identifier in the SessionHandler backend.  
|Destroy the data for a particular session identifier in the SessionHandler backend.  
|-
|-
|[[JSessionStorage::gc/11.1|gc]]
|public
|[[API17:JSessionStorage::gc|gc]]
|Garbage collect stale sessions from the SessionHandler backend.  
|Garbage collect stale sessions from the SessionHandler backend.  
|-
|-
|[[JSessionStorage::open/11.1|open]]
|public
|[[API17:JSessionStorage::open|open]]
|Open the SessionHandler backend.  
|Open the SessionHandler backend.  
|-
|-
|[[JSessionStorage::read/11.1|read]]
|public
|[[API17:JSessionStorage::read|read]]
|Read the data for a particular session identifier from the SessionHandler backend.  
|Read the data for a particular session identifier from the SessionHandler backend.  
|-
|-
|[[JSessionStorage::register/11.1|register]]
|public
|[[API17:JSessionStorage::register|register]]
|Register the functions of this class with PHP's session handler.  
|Register the functions of this class with PHP's session handler.  
|-
|-
|[[JSessionStorage::write/11.1|write]]
|public
|[[API17:JSessionStorage::write|write]]
|Write session data to the SessionHandler backend.  
|Write session data to the SessionHandler backend.  
|-
|-
|[[JSessionStorage::getInstance/11.1|getInstance]]
|public static
|[[API17:JSessionStorage::getInstance|getInstance]]
|Returns a session storage handler object, only creating it if it doesn't already exist.  
|Returns a session storage handler object, only creating it if it doesn't already exist.  
|-
|-
|[[JSessionStorage::test/11.1|test]]
|public static
|[[API17:JSessionStorage::test|test]]
|Test to see if the SessionHandler is available.  
|Test to see if the SessionHandler is available.  
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/session/storage.php
* '''Extends''' [[API17:JObject|JObject]]
* '''Extended by'''
** [[API17:JSessionStorageApc|JSessionStorageApc]]
** [[API17:JSessionStorageDatabase|JSessionStorageDatabase]]
** [[API17:JSessionStorageEaccelerator|JSessionStorageEaccelerator]]
** [[API17:JSessionStorageMemcache|JSessionStorageMemcache]]
** [[API17:JSessionStorageNone|JSessionStorageNone]]
** [[API17:JSessionStorageWincache|JSessionStorageWincache]]
** [[API17:JSessionStorageXcache|JSessionStorageXcache]]
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.session.storage' );</source>
<source lang="php">jimport( 'joomla.session.storage' );</source>
===See also===
===See also===
* [[JSessionStorage|Other versions of this class]]
* {{JVer|11.1}} '''JSessionStorage source code''' on [[jplatform:session/storage.php|BitBucket]]
{{SeeAlso:JSessionStorage}}
* {{JVer|11.1}} Subpackage [[API17:Subpackage Session|Session]]
<span class="editsection" style="font-size:76%;">
* [[API17:JSessionStorage|Other versions of JSessionStorage]]
<nowiki>[</nowiki>[[SeeAlso:JSessionStorage|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
===Examples===
===User contributed notes===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
noresultsheader=\n
noresultsheader=\n
category=JSessionStorage
category=JSessionStorage
category=CodeExample
namespace=CodeExample
category=ClassExample
category=ClassExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JSessionStorage]]</noinclude>
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 03:39, 25 March 2017

Joomla 11.1 JSessionStorage

Description

Methods

Visibility Method name Description
public __construct Constructor.
public close Close the SessionHandler backend.
public destroy Destroy the data for a particular session identifier in the SessionHandler backend.
public gc Garbage collect stale sessions from the SessionHandler backend.
public open Open the SessionHandler backend.
public read Read the data for a particular session identifier from the SessionHandler backend.
public register Register the functions of this class with PHP's session handler.
public write Write session data to the SessionHandler backend.
public static getInstance Returns a session storage handler object, only creating it if it doesn't already exist.
public static test Test to see if the SessionHandler is available.

Importing

jimport( 'joomla.session.storage' );

See also


User contributed notes

Code Examples


Retrieved from "https://docs.sandbox.joomla.org/index.php?title=API17:JSessionStorage&oldid=386000"