JSessionStorageXcache: Difference between revisions
From Joomla! Documentation
m →User contributed notes: bad link repair |
m preparing for archive only |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JSessionStorageXcache== | =={{JVer|11.1}} JSessionStorageXcache== | ||
===Description=== | ===Description=== | ||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::close | |[[API17:JSessionStorageXcache::close|close]] | ||
|Close the SessionHandler backend. | |Close the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::destroy | |[[API17:JSessionStorageXcache::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. | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::gc | |[[API17:JSessionStorageXcache::gc|gc]] | ||
|Garbage collect stale sessions from the SessionHandler backend. | |Garbage collect stale sessions from the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::open | |[[API17:JSessionStorageXcache::open|open]] | ||
|Open the SessionHandler backend. | |Open the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::read | |[[API17:JSessionStorageXcache::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. | ||
|- | |- | ||
|public | |public | ||
|[[JSessionStorageXcache::write | |[[API17:JSessionStorageXcache::write|write]] | ||
|Write session data to the SessionHandler backend. | |Write session data to the SessionHandler backend. | ||
|- | |- | ||
|public static | |public static | ||
|[[JSessionStorageXcache::test | |[[API17:JSessionStorageXcache::test|test]] | ||
|Test to see if the SessionHandler is available. | |Test to see if the SessionHandler is available. | ||
|- | |- | ||
|protected | |protected | ||
|[[JSessionStorageXcache::__construct | |[[API17:JSessionStorageXcache::__construct|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/session/storage/xcache.php | * '''Defined in''' libraries/joomla/session/storage/xcache.php | ||
* '''Extends''' [[JSessionStorage | * '''Extends''' [[API17:JSessionStorage|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=== | ||
* {{JVer|11.1}} '''JSessionStorageXcache source code''' on [[jplatform:session/storage/xcache.php|BitBucket]] | * {{JVer|11.1}} '''JSessionStorageXcache source code''' on [[jplatform:session/storage/xcache.php|BitBucket]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage Session | * {{JVer|11.1}} Subpackage [[API17:Subpackage Session|Session]] | ||
* [[JSessionStorageXcache|Other versions of JSessionStorageXcache]] | * [[API17:JSessionStorageXcache|Other versions of JSessionStorageXcache]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JSessionStorageXcache | category=JSessionStorageXcache | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| Line 69: | Line 65: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude> | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> | ||
Latest revision as of 03:42, 25 March 2017
JSessionStorageXcache
Description
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
- JSessionStorageXcache source code on BitBucket
- Subpackage Session
- Other versions of JSessionStorageXcache
User contributed notes
Code Examples