JoomlaStorage
Extends \Joomla\Session\Storage\NativeStorageService provider for the application's session dependency
| since |
4.0.0 |
|---|---|
| package |
Application |
Methods
__construct
Constructor
__construct(\Joomla\Input\Input input, \SessionHandlerInterface handler = null, array options = []) : mixed
| since |
4.0.0 |
|---|
Arguments
- input
\Joomla\Input\InputInput object- handler
\SessionHandlerInterfaceSession save handler- options
arraySession options
Response
mixed
all
Retrieves all variables from the session store
all() : array
| since |
4.0.0 |
|---|
Response
array
clear
Clears all variables from the session store
clear() : void
| since |
4.0.0 |
|---|
close
Writes session data and ends session
close() : void
| see | \Joomla\CMS\Session\Storage\session_write_close() |
|---|---|
| since |
4.0.0 |
get
Get data from the session store
get(string name, mixed default) : mixed
| since |
4.0.0 |
|---|
Arguments
- name
stringName of a variable- default
mixedDefault value of a variable if not set
Response
mixedValue of a variable
has
Check whether data exists in the session store
has(string name) : bool
| since |
4.0.0 |
|---|
Arguments
- name
stringName of variable
Response
boolTrue if the variable exists
remove
Unset a variable from the session store
remove(string name) : mixed
| since |
4.0.0 |
|---|
Arguments
- name
stringName of variable
Response
mixedThe value from session or NULL if not set
set
Set data into the session store
set(string name, mixed value = null) : mixed
| since |
4.0.0 |
|---|
Arguments
- name
stringName of a variable.- value
mixedValue of a variable.
Response
mixedOld value of a variable.
setCookieParams
Set session cookie parameters
setCookieParams() : void
| since |
4.0.0 |
|---|
setOptions
Sets session options
setOptions(array options) : $this
| see |
http://php.net/session.configuration |
|---|---|
| since |
4.0.0 |
Arguments
- options
arraySession ini directives array(key => value).
Response
$this
start
Start a session
start() : void
| since |
4.0.0 |
|---|
Properties
data
Internal data store for the session data
| since |
4.0.0 |
|---|
Type(s)
\Joomla\Registry\Registry
input
Input object
| since |
4.0.0 |
|---|
Type(s)
\Joomla\Input\Input