JSessionStorageApc
Extends \JSessionStorageAPC session storage handler for PHP
| link |
https://www.php.net/manual/en/function.session-set-save-handler.php |
|---|---|
| since |
1.7.0 |
| deprecated |
4.0 The CMS' Session classes will be replaced with the |
| package |
Joomla.Platform |
Methods
__construct
Constructor
__construct(array $options = array())
| since |
1.7.0 |
|---|
Arguments
- $options
arrayOptional parameters.
close
Close the SessionHandler backend.
close() : boolean
| since |
1.7.0 |
|---|
Response
booleanTrue on success, false otherwise.
destroy
Destroy the data for a particular session identifier in the SessionHandler backend.
destroy(string $id) : boolean
| since |
1.7.0 |
|---|
Arguments
- $id
stringThe session identifier.
Response
booleanTrue on success, false otherwise.
gc
Garbage collect stale sessions from the SessionHandler backend.
gc(integer $maxlifetime = null) : boolean
| since |
1.7.0 |
|---|
Arguments
- $maxlifetime
integerThe maximum age of a session.
Response
booleanTrue on success, false otherwise.
getInstance
Returns a session storage handler object, only creating it if it doesn't already exist.
getInstance(string $name = 'none', array $options = array()) : \JSessionStorage
| since |
1.7.0 |
|---|---|
| throws |
|
Arguments
- $name
stringThe session store to instantiate- $options
arrayArray of options
Response
isSupported
Test to see if the SessionHandler is available.
isSupported() : boolean
| since |
3.0.0 |
|---|
Response
booleanTrue on success, false otherwise.
open
Open the SessionHandler backend.
open(string $savePath, string $sessionName) : boolean
| since |
1.7.0 |
|---|
Arguments
- $savePath
stringThe path to the session object.- $sessionName
stringThe name of the session.
Response
booleanTrue on success, false otherwise.
read
Read the data for a particular session identifier from the SessionHandler backend.
read(string $id) : string
| since |
1.7.0 |
|---|
Arguments
- $id
stringThe session identifier.
Response
stringThe session data.
register
Register the functions of this class with PHP's session handler
register() : void
| since |
1.7.0 |
|---|
test
Test to see if the SessionHandler is available.
test() : boolean
| since |
1.7.0 |
|---|---|
| deprecated |
4.0 - Use JSessionStorage::isSupported() instead. |
Response
booleanTrue on success, false otherwise.
write
Write session data to the SessionHandler backend.
write(string $id, string $sessionData) : boolean
| since |
1.7.0 |
|---|
Arguments
- $id
stringThe session identifier.- $sessionData
stringThe session data.
Response
booleanTrue on success, false otherwise.
Properties
instances
JSessionStorage instances container.