Difference between revisions of "JSessionStorage"
From Joomla! Documentation
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JSessionStorage== | ||
| + | ===Description=== | ||
| + | {{Description:JSessionStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JSessionStorage|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JSessionStorage|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::__construct/11.1|__construct]] | |[[JSessionStorage::__construct/11.1|__construct]] | ||
|Constructor. | |Constructor. | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::close/11.1|close]] | |[[JSessionStorage::close/11.1|close]] | ||
|Close the SessionHandler backend. | |Close the SessionHandler backend. | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::destroy/11.1|destroy]] | |[[JSessionStorage::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 | ||
|[[JSessionStorage::gc/11.1|gc]] | |[[JSessionStorage::gc/11.1|gc]] | ||
|Garbage collect stale sessions from the SessionHandler backend. | |Garbage collect stale sessions from the SessionHandler backend. | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::open/11.1|open]] | |[[JSessionStorage::open/11.1|open]] | ||
|Open the SessionHandler backend. | |Open the SessionHandler backend. | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::read/11.1|read]] | |[[JSessionStorage::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 | ||
|[[JSessionStorage::register/11.1|register]] | |[[JSessionStorage::register/11.1|register]] | ||
|Register the functions of this class with PHP's session handler. | |Register the functions of this class with PHP's session handler. | ||
|- | |- | ||
| + | |public | ||
|[[JSessionStorage::write/11.1|write]] | |[[JSessionStorage::write/11.1|write]] | ||
|Write session data to the SessionHandler backend. | |Write session data to the SessionHandler backend. | ||
|- | |- | ||
| + | |public static | ||
|[[JSessionStorage::getInstance/11.1|getInstance]] | |[[JSessionStorage::getInstance/11.1|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. | ||
|- | |- | ||
| + | |public static | ||
|[[JSessionStorage::test/11.1|test]] | |[[JSessionStorage::test/11.1|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''' [[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]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.session.storage' );</source> | <source lang="php">jimport( 'joomla.session.storage' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JSessionStorage source code | + | * {{JVer|11.1}} '''JSessionStorage source code''' on [[jplatform:session/storage.php|BitBucket]] |
| − | * [[JSessionStorage|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Session/11.1|Session]] |
| + | * [[JSessionStorage|Other versions of JSessionStorage]] | ||
{{SeeAlso:JSessionStorage}} | {{SeeAlso:JSessionStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JSessionStorage|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JSessionStorage|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 73: | Line 82: | ||
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]][[Category:Platform 11.1]][[Category:JSessionStorage]]</noinclude> | ||
Revision as of 18:08, 27 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.
JSessionStorage[edit]
Description[edit]
Template:Description:JSessionStorage [Edit Descripton]
Methods[edit]
| 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. |
- Defined in libraries/joomla/session/storage.php
- Extends JObject
- Extended by
Importing[edit]
jimport( 'joomla.session.storage' );See also[edit]
- JSessionStorage source code on BitBucket
- Subpackage Session
- Other versions of JSessionStorage
Template:SeeAlso:JSessionStorage [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />