Difference between revisions of "JSessionStorage"
From Joomla! Documentation
m (→User contributed notes: bad link repair) |
m (moving preparation) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 14: | Line 14: | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::__construct | + | |[[API17:JSessionStorage::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::close | + | |[[API17:JSessionStorage::close|close]] |
|Close the SessionHandler backend. | |Close the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::destroy | + | |[[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. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::gc | + | |[[API17:JSessionStorage::gc|gc]] |
|Garbage collect stale sessions from the SessionHandler backend. | |Garbage collect stale sessions from the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::open | + | |[[API17:JSessionStorage::open|open]] |
|Open the SessionHandler backend. | |Open the SessionHandler backend. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::read | + | |[[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. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::register | + | |[[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. | ||
|- | |- | ||
|public | |public | ||
− | |[[JSessionStorage::write | + | |[[API17:JSessionStorage::write|write]] |
|Write session data to the SessionHandler backend. | |Write session data to the SessionHandler backend. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JSessionStorage::getInstance | + | |[[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. | ||
|- | |- | ||
|public static | |public static | ||
− | |[[JSessionStorage::test | + | |[[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 | * '''Defined in''' libraries/joomla/session/storage.php | ||
− | * '''Extends''' [[JObject | + | * '''Extends''' [[API17:JObject|JObject]] |
* '''Extended by''' | * '''Extended by''' | ||
− | ** [[JSessionStorageApc | + | ** [[API17:JSessionStorageApc|JSessionStorageApc]] |
− | ** [[JSessionStorageDatabase | + | ** [[API17:JSessionStorageDatabase|JSessionStorageDatabase]] |
− | ** [[JSessionStorageEaccelerator | + | ** [[API17:JSessionStorageEaccelerator|JSessionStorageEaccelerator]] |
− | ** [[JSessionStorageMemcache | + | ** [[API17:JSessionStorageMemcache|JSessionStorageMemcache]] |
− | ** [[JSessionStorageNone | + | ** [[API17:JSessionStorageNone|JSessionStorageNone]] |
− | ** [[JSessionStorageWincache | + | ** [[API17:JSessionStorageWincache|JSessionStorageWincache]] |
− | ** [[JSessionStorageXcache | + | ** [[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=== | ||
* {{JVer|11.1}} '''JSessionStorage source code''' on [[jplatform:session/storage.php|BitBucket]] | * {{JVer|11.1}} '''JSessionStorage source code''' on [[jplatform:session/storage.php|BitBucket]] | ||
− | * {{JVer|11.1}} Subpackage [[Subpackage Session | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Session|Session]] |
− | * [[JSessionStorage|Other versions of JSessionStorage]] | + | * [[API17:JSessionStorage|Other versions of JSessionStorage]] |
{{SeeAlso:JSessionStorage}} | {{SeeAlso:JSessionStorage}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
Line 85: | Line 85: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Revision as of 21:28, 11 May 2013
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 />