Back to Joomla project (class list)

Class JoomlaStorage - list of methods

Service provider for the application's session dependency
Package: Joomla\CMS\Session\Storage
Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE
Located at: Joomla/Session/Storage/JoomlaStorage.php
Project: Joomla

Method Summary

public
(\Joomla\Input\Input $input, \SessionHandlerInterface $handler = null, array $options = [])

Constructor
Parameters
  • \Joomla\Input\Input $input Input object
  • \SessionHandlerInterface $handler Session save handler
  • array $options Session options
Since
  • 4.0.0
Show source code of this method: __construct Source Code

public array
()

Retrieves all variables from the session store
Returns
  • array
Since
  • 4.0.0
Show source code of this method: all Source Code

public void
()

Clears all variables from the session store
Returns
  • void
Since
  • 4.0.0
Show source code of this method: clear Source Code

public void
()

Writes session data and ends session
Returns
  • void
Since
  • 4.0.0
-
  • \Joomla\CMS\Session\Storage\session_write_close()
Show source code of this method: close Source Code

public mixed
(string $name, mixed $default)

Get data from the session store
Parameters
  • string $name Name of a variable
  • mixed $default Default value of a variable if not set
Returns
  • mixed Value of a variable
Since
  • 4.0.0
Show source code of this method: get Source Code

public bool
(string $name)

Check whether data exists in the session store
Parameters
  • string $name Name of variable
Returns
  • bool True if the variable exists
Since
  • 4.0.0
Show source code of this method: has Source Code

public mixed
(string $name)

Unset a variable from the session store
Parameters
  • string $name Name of variable
Returns
  • mixed The value from session or NULL if not set
Since
  • 4.0.0
Show source code of this method: remove Source Code

public mixed
(string $name, mixed $value = null)

Set data into the session store
Parameters
  • string $name Name of a variable.
  • mixed $value Value of a variable.
Returns
  • mixed Old value of a variable.
Since
  • 4.0.0
Show source code of this method: set Source Code

protected void
()

Set session cookie parameters
Returns
  • void
Since
  • 4.0.0
Show source code of this method: setCookieParams Source Code

public $this
(array $options)

Sets session options
Parameters
  • array $options Session ini directives array(key => value).
Returns
  • $this
Since
  • 4.0.0
-
  • http://php.net/session.configuration
Show source code of this method: setOptions Source Code

public void
()

Start a session
Returns
  • void
Since
  • 4.0.0
Show source code of this method: start Source Code

Properties Summary

private \Joomla\Registry\Registry
$data
Internal data store for the session data
Since
  • 4.0.0
private bool
$forceSSL
Force cookies to be SSL only
Since
  • 4.0.0
private \Joomla\Input\Input
$input
Input object
Since
  • 4.0.0

Tags Summary

Since
4.0.0