JSessionStorageWincache

Extends \JSessionStorage

WINCACHE session storage handler for PHP

deprecated
since

1.7.0

deprecated

4.0 The CMS' Session classes will be replaced with the joomla/session package

package

Joomla.Platform

Methods

__construct

Constructor

__construct(array $options = array()) 
inherited
since

1.7.0

Arguments

$options

arrayOptional parameters.

close

Close the SessionHandler backend.

close() : boolean
inherited
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
inherited
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
inherited
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
inherited static
since

1.7.0

throws

\JSessionExceptionUnsupported

Arguments

$name

stringThe session store to instantiate

$options

arrayArray of options

Response

\JSessionStorage

isSupported

Test to see if the SessionHandler is available.

isSupported() : boolean
inherited static
since

3.0.0

Response

booleanTrue on success, false otherwise.

open

Open the SessionHandler backend.

open(string $save_path, string $session_name) : boolean
inherited
since

1.7.0

Arguments

$save_path

stringThe path to the session object.

$session_name

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
inherited
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
inherited
since

1.7.0

test

Test to see if the SessionHandler is available.

test() : boolean
inherited static deprecated
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 $session_data) : boolean
inherited
since

1.7.0

Arguments

$id

stringThe session identifier.

$session_data

stringThe session data.

Response

booleanTrue on success, false otherwise.

Properties

instances

JSessionStorage instances container.

inherited static
since

1.7.3

Type(s)

array<mixed,\JSessionStorage>