JoomlaStorage
Extends NativeStorageService provider for the application's session dependency
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor
__construct(\Joomla\Input\Input input, \SessionHandlerInterface handler = null, mixed||string|int options = []) :
| since |
4.0.0 |
|---|
Arguments
- input
InputInput object- handler
SessionHandlerInterfaceSession save handler- options
array<string|int, mixed>Session options
Response
mixed
all
Retrieves all variables from the session store
all() : mixed||string|int
| since |
4.0.0 |
|---|
Response
array<string|int, mixed>
clear
Clears all variables from the session store
clear() :
| since |
4.0.0 |
|---|
Response
void
close
Writes session data and ends session
close() :
| see | session_write_close() |
|---|---|
| since |
4.0.0 |
Response
void
get
Get data from the session store
get( name, default) :
| 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( name) :
| since |
4.0.0 |
|---|
Arguments
- name
stringName of variable
Response
boolTrue if the variable exists
remove
Unset a variable from the session store
remove( name) :
| 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( name, value = null) :
| 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() :
| since |
4.0.0 |
|---|
Response
void
setOptions
Sets session options
setOptions(mixed||string|int options) :
| see |
http://php.net/session.configuration |
|---|---|
| since |
4.0.0 |
Arguments
- options
array<string|int, mixed>Session ini directives array(key => value).
Response
$this
start
Start a session
start() :
| since |
4.0.0 |
|---|
Response
void
Properties
data
Internal data store for the session data
| since |
4.0.0 |
|---|
Type(s)
Registry
forceSSL
Force cookies to be SSL only
| since |
4.0.0 |
|---|
Type(s)
bool
input
Input object
| since |
4.0.0 |
|---|
Type(s)
Input