Class JSessionStorage

Custom session storage handler for PHP

Direct known subclasses

JSessionStorageApc, JSessionStorageDatabase, JSessionStorageMemcache, JSessionStorageMemcached, JSessionStorageNone, JSessionStorageWincache, JSessionStorageXcache

Abstract
Package: Joomla\Platform\Session
Deprecated: 4.0 The CMS' Session classes will be replaced with the joomla/session package
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE
Since: 11.1
Link: https://secure.php.net/manual/en/function.session-set-save-handler.php
Located at joomla/session/storage.php

Methods summary

`public`	# `__construct( array $options = array() )` Constructor Constructor Parameters `$options` `array` - $options Optional parameters. Since 11.1
`public static JSessionStorage`	# `getInstance( string $name = 'none', array $options = array() )` 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. Parameters `$name` `string` - $name The session store to instantiate `$options` `array` - $options Array of options Returns `JSessionStorage` Throws `JSessionExceptionUnsupported` Since 11.1
`public`	# `register( )` Register the functions of this class with PHP's session handler Register the functions of this class with PHP's session handler Since 11.1
`public boolean`	# `open( string $save_path, string $session_name )` Open the SessionHandler backend. Open the SessionHandler backend. Parameters `$save_path` `string` - $save_path The path to the session object. `$session_name` `string` - $session_name The name of the session. Returns `boolean` - True on success, false otherwise. Since 11.1
`public boolean`	# `close( )` Close the SessionHandler backend. Close the SessionHandler backend. Returns `boolean` - True on success, false otherwise. Since 11.1
`public string`	# `read( string $id )` Read the data for a particular session identifier from the SessionHandler backend. Read the data for a particular session identifier from the SessionHandler backend. Parameters `$id` `string` - $id The session identifier. Returns `string` - The session data. Since 11.1
`public boolean`	# `write( string $id, string $session_data )` Write session data to the SessionHandler backend. Write session data to the SessionHandler backend. Parameters `$id` `string` - $id The session identifier. `$session_data` `string` - $session_data The session data. Returns `boolean` - True on success, false otherwise. Since 11.1
`public boolean`	# `destroy( string $id )` Destroy the data for a particular session identifier in the SessionHandler backend. Destroy the data for a particular session identifier in the SessionHandler backend. Parameters `$id` `string` - $id The session identifier. Returns `boolean` - True on success, false otherwise. Since 11.1
`public boolean`	# `gc( integer $maxlifetime = null )` Garbage collect stale sessions from the SessionHandler backend. Garbage collect stale sessions from the SessionHandler backend. Parameters `$maxlifetime` `integer` - $maxlifetime The maximum age of a session. Returns `boolean` - True on success, false otherwise. Since 11.1
`public static boolean`	# `isSupported( )` Test to see if the SessionHandler is available. Test to see if the SessionHandler is available. Returns `boolean` - True on success, false otherwise. Since 12.1
`public static boolean`	# `test( )` Test to see if the SessionHandler is available. Test to see if the SessionHandler is available. Returns `boolean` - True on success, false otherwise. Since 11.1

Magic methods summary

Properties summary

`protected static JSessionStorage[]`	`$instances`	# JSessionStorage instances container. JSessionStorage instances container. Since 11.3

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JSessionStorage

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Throws

Since

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Since