Class Storage

Custom session storage handler for PHP

Direct known subclasses

Joomla\Session\Storage\Apc, Joomla\Session\Storage\Database, Joomla\Session\Storage\Memcache, Joomla\Session\Storage\Memcached, Joomla\Session\Storage\None, Joomla\Session\Storage\Wincache, Joomla\Session\Storage\Xcache

Abstract
Namespace: Joomla\Session
Deprecated: 2.0 The Storage class chain will be removed.
Since: 1.0
See: http://www.php.net/manual/en/function.session-set-save-handler.php
Located at vendor/joomla/session/Joomla/Session/Storage.php

Methods summary

`public`	# `__construct( array $options = array() )` Constructor Constructor Parameters `$options` `array` - $options Optional parameters. Since 1.0
`public static Joomla\Session\Storage`	# `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 `Joomla\Session\Storage` Since 1.0
`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 1.0
`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 1.0
`public boolean`	# `close( )` Close the SessionHandler backend. Close the SessionHandler backend. Returns `boolean` - True on success, false otherwise. Since 1.0
`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 1.0
`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 1.0
`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 1.0
`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 1.0
`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 1.0

Magic methods summary

Properties summary

`protected static Joomla\Session\Storage[]`	`$instances`	# Storage instances container. Storage instances container. Deprecated 2.0 Since 1.0

Namespaces

Classes

Class Storage

Direct known subclasses

Methods summary

Parameters

Since

Parameters

Returns

Since

Since

Parameters

Returns

Since

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Returns

Since

Magic methods summary

Properties summary

Deprecated

Since