API17

JSessionStorageXcache: Difference between revisions

From Joomla! Documentation

Doxiki2 (talk | contribs)
Layout updates
Doxiki2 (talk | contribs)
Updated to r1448:247ba8d88526
Line 1: Line 1:
__NOTOC__
__NOTOC__
=={{JVer|11.1}} JSessionStorageXcache==
===Description===
{{Description:JSessionStorageXcache}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JSessionStorageXcache|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[Description:JSessionStorageXcache|Edit Descripton]]<nowiki>]</nowiki>
</span>
</span>
{{Description:JSessionStorageXcache}}
===Defined in===
libraries/joomla/session/storage/xcache.php
* see source code in [[jplatform:session/storage/xcache.php|BitBucket]]
===Subpackage===
[[Subpackage Session/11.1|Session]]
===Extends===
[[JSessionStorage/11.1|JSessionStorage]]
===Extended by===
===Methods===
===Methods===
{| class="wikitable sortable"
{| class="wikitable sortable"
|-
|-
!Visibility
!Method name
!Method name
!Description
!Description
|-
|-
|[[JSessionStorageXcache::__construct/11.1|__construct]]
|public
|Constructor.
|-
|[[JSessionStorageXcache::close/11.1|close]]
|[[JSessionStorageXcache::close/11.1|close]]
|Close the SessionHandler backend.  
|Close the SessionHandler backend.  
|-
|-
|public
|[[JSessionStorageXcache::destroy/11.1|destroy]]
|[[JSessionStorageXcache::destroy/11.1|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.  
|-
|-
|public
|[[JSessionStorageXcache::gc/11.1|gc]]
|[[JSessionStorageXcache::gc/11.1|gc]]
|Garbage collect stale sessions from the SessionHandler backend.  
|Garbage collect stale sessions from the SessionHandler backend.  
|-
|-
|public
|[[JSessionStorageXcache::open/11.1|open]]
|[[JSessionStorageXcache::open/11.1|open]]
|Open the SessionHandler backend.  
|Open the SessionHandler backend.  
|-
|-
|public
|[[JSessionStorageXcache::read/11.1|read]]
|[[JSessionStorageXcache::read/11.1|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.  
|-
|-
|public
|[[JSessionStorageXcache::write/11.1|write]]
|[[JSessionStorageXcache::write/11.1|write]]
|Write session data to the SessionHandler backend.  
|Write session data to the SessionHandler backend.  
|-
|-
|public static
|[[JSessionStorageXcache::test/11.1|test]]
|[[JSessionStorageXcache::test/11.1|test]]
|Test to see if the SessionHandler is available.  
|Test to see if the SessionHandler is available.  
|-
|protected
|[[JSessionStorageXcache::__construct/11.1|__construct]]
|Constructor.
|-
|-
|}
|}
* '''Defined in''' libraries/joomla/session/storage/xcache.php
* '''Extends''' [[JSessionStorage/11.1|JSessionStorage]]
===Importing===
===Importing===
<source lang="php">jimport( 'joomla.session.storage.xcache' );</source>
<source lang="php">jimport( 'joomla.session.storage.xcache' );</source>
===See also===
===See also===
* JSessionStorageXcache source code in [[jplatform:session/storage/xcache.php|BitBucket]]
* {{JVer|11.1}} '''JSessionStorageXcache source code''' on [[jplatform:session/storage/xcache.php|BitBucket]]
* [[JSessionStorageXcache|Other versions of this class]]
* {{JVer|11.1}} Subpackage [[Subpackage Session/11.1|Session]]
* [[JSessionStorageXcache|Other versions of JSessionStorageXcache]]
{{SeeAlso:JSessionStorageXcache}}
{{SeeAlso:JSessionStorageXcache}}
<span class="editsection" style="font-size:76%;">
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JSessionStorageXcache|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[</nowiki>[[SeeAlso:JSessionStorageXcache|Edit See Also]]<nowiki>]</nowiki>
</span>
</span>
===Examples===
===User contributed notes===
<CodeExamplesForm />
<CodeExamplesForm />
<dpl>
<dpl>
Line 60: Line 66:
category=ClassExample
category=ClassExample
include=*
include=*
namespace=CodeExample
format= ,,,
format= ,,,
</dpl>
</dpl>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JSessionStorageXcache]]</noinclude>
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JSessionStorageXcache]]</noinclude>

Revision as of 23:08, 27 April 2011

Joomla 11.1 JSessionStorageXcache

Description

Template:Description:JSessionStorageXcache [Edit Descripton]

Methods

Visibility Method name Description
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 write Write session data to the SessionHandler backend.
public static test Test to see if the SessionHandler is available.
protected __construct Constructor.
  • Defined in libraries/joomla/session/storage/xcache.php
  • Extends JSessionStorage

Importing

jimport( 'joomla.session.storage.xcache' );

See also

Template:SeeAlso:JSessionStorageXcache [Edit See Also]

User contributed notes

<CodeExamplesForm />