Joomla! API

Constructor

__construct(string $store = 'none', array $options = array())

since	1.0

Arguments

$store: stringThe type of storage for the session.
$options: arrayOptional parameters

Magic method to get read-only access to properties.

__get(string $name) : mixed

deprecated

since	1.0
deprecated	2.0 Use get methods for non-deprecated properties

Arguments

$name: stringName of property to retrieve

Response

mixedThe value of the property

Create a token-string

_createToken(integer $length = 32) : string

deprecated

since	1.0
deprecated	2.0 Use createToken instead

Arguments

$length: integerLength of string {@deprecated As of 2.0 the session token will be a fixed length}

Response

stringGenerated token

Set session cookie parameters

_setCookieParams() : void

deprecated

since	1.0
deprecated	2.0

Set counter of session usage

_setCounter() : boolean

deprecated

since	1.0
deprecated	2.0 Use setCounter instead

Response

booleanTrue on success

Set additional session options

_setOptions(array $options) : boolean

deprecated

since	1.0
deprecated	2.0 Use setOptions instead

Arguments

$options: arrayList of parameter

Response

booleanTrue on success

Set the session timers

_setTimers() : boolean

deprecated

since	1.0
deprecated	2.0 Use setTimers instead

Response

booleanTrue on success

Start a session.

_start() : boolean

deprecated

Creates a session (or resumes the current one based on the state of the session)

since	1.0
deprecated	2.0

Response

booleantrue on success

Do some checks for security reason

_validate(boolean $restart = false) : boolean

deprecated

timeout check (expire)
ip-fixiation
browser-fixiation

If one check failed, session data has to be cleaned.

link	http://shiflett.org/articles/the-truth-about-sessions
since	1.0
deprecated	2.0 Use validate instead

Arguments

$restart: booleanReactivate session

Response

booleanTrue on success

Unset data from the session store

clear(string $name, string $namespace = 'default') : mixed

since	1.0

Arguments

$name: stringName of variable
$namespace: stringNamespace to use, default to 'default' {@deprecated 2.0 Namespace support will be removed.}

Response

mixedThe value from session or NULL if not set

Writes session data and ends session

close() : void

Session data is usually stored after your script terminated without the need to call JSession::close(), but as session data is locked to prevent concurrent writes only one script may operate on a session at any time. When using framesets together with sessions you will experience the frames loading one by one due to this locking. You can reduce the time needed to load all the frames by ending the session as soon as all changes to session variables are done.

see	\Joomla\Session\session_write_close()
since	1.0

Create a token-string

createToken(integer $length = 32) : string

since	1.3.1

Arguments

$length: integerLength of string {@deprecated As of 2.0 the session token will be a fixed length}

Response

stringGenerated token

Frees all session variables and destroys all data registered to a session

destroy() : boolean

This method resets the $_SESSION variable and destroys all of the data associated with the current session in its storage (file or DB). It forces new session to be started after this method is called. It does not unset the session cookie.

see	\Joomla\Session\session_destroy() \Joomla\Session\session_unset()
since	1.0

Response

booleanTrue on success

Create a new session and copy variables from the old one

fork() : boolean

since	1.0

Response

boolean$result true on success

Get data from the session store

get(string $name, mixed $default = null, string $namespace = 'default') : mixed

since	1.0

Arguments

$name: stringName of a variable
$default: mixedDefault value of a variable if not set
$namespace: stringNamespace to use, default to 'default' {@deprecated 2.0 Namespace support will be removed.}

Response

mixedValue of a variable

Get expiration time in minutes

getExpire() : integer

since	1.0

Response

integerThe session expiration time in minutes

Get session id

getId() : string

since	1.0

Response

stringThe session name

Returns the global Session object, only creating it if it doesn't already exist.

getInstance(string $handler, array $options = array()) : \Joomla\Session\Session

static deprecated

since	1.0
deprecated	2.0 A singleton object store will no longer be supported

Arguments

$handler: stringThe type of session handler.
$options: arrayAn array of configuration options (for new sessions only).

Response

\Joomla\Session\SessionThe Session object.

Retrieve an external iterator.

getIterator() : \ArrayIterator

since	1.0

Response

\ArrayIteratorReturn an ArrayIterator of $_SESSION.

Get session name

getName() : string

since	1.0

Response

stringThe session name

Get current state of session

getState() : string

since	1.0

Response

stringThe session state

Get the session handlers

getStores() : array

static deprecated

since	1.0
deprecated	2.0 The Storage class chain will be removed

Response

arrayAn array of available session handlers

Get a session token, if a token isn't set yet one will be generated.

getToken(boolean $forceNew = false) : string

Tokens are used to secure forms from spamming attacks. Once a token has been generated the system will check the post request to see if it is present, if not it will invalidate the session.

since	1.0

Arguments

$forceNew: booleanIf true, force a new token to be created

Response

stringThe session token

Check whether data exists in the session store

has(string $name, string $namespace = 'default') : boolean

since	1.0

Arguments

$name: stringName of variable
$namespace: stringNamespace to use, default to 'default' {@deprecated 2.0 Namespace support will be removed.}

Response

booleanTrue if the variable exists

Method to determine if a token exists in the session. If not the session will be set to expired

hasToken(string $tCheck, boolean $forceExpire = true) : boolean

since	1.0

Arguments

$tCheck: stringHashed token to be verified
$forceExpire: booleanIf true, expires the session

Response

boolean

Check whether this session is currently created

initialise(\Joomla\Input\Input $input, \Joomla\Event\DispatcherInterface $dispatcher = null) : void

deprecated

since	1.0
deprecated	2.0 In 2.0 the DispatcherInterface should be injected via the object constructor

Arguments

$input: \Joomla\Input\InputInput object for the session to use.
$dispatcher: \Joomla\Event\DispatcherInterfaceDispatcher object for the session to use.

Shorthand to check if the session is active

isActive() : boolean

since	1.0

Response

boolean

Check whether this session is currently created

isNew() : boolean

since	1.0

Response

booleanTrue on success.

Restart an expired or locked session.

restart() : boolean

see	\Joomla\Session\destroy
since	1.0

Response

booleanTrue on success

Set data into the session store.

set(string $name, mixed $value = null, string $namespace = 'default') : mixed

since	1.0

Arguments

$name: stringName of a variable.
$value: mixedValue of a variable.
$namespace: stringNamespace to use, default to 'default' {@deprecated 2.0 Namespace support will be removed.}

Response

mixedOld value of a variable.

Set counter of session usage

setCounter() : boolean

since	1.3.0

Response

booleanTrue on success

Set the session expiration

setExpire(integer $expire) : $this

since	1.3.0

Arguments

$expire: integerMaximum age of unused session in minutes

Response

$this

Set additional session options

setOptions(array $options) : boolean

since	1.3.0

Arguments

$options: arrayList of parameter

Response

booleanTrue on success

Set the session state

setState(string $state) : $this

since	1.3.0

Arguments

$state: stringInternal state

Response

$this

Set the session timers

setTimers() : boolean

since	1.3.0

Response

booleanTrue on success

Start a session.

start() : void

since	1.0

Do some checks for security reason

validate(boolean $restart = false) : boolean

timeout check (expire)
ip-fixiation
browser-fixiation

If one check failed, session data has to be cleaned.

link	http://shiflett.org/articles/the-truth-about-sessions
since	1.3.0

Arguments

$restart: booleanReactivate session

Response

booleanTrue on success

Internal state.

One of 'inactive'|'active'|'expired'|'destroyed'|'error'

see	\Joomla\Session\Session::getState()
since	1.0

Type(s)

string

Maximum age of unused session in minutes

since	1.0

Type(s)

string

The session store object.

since	1.0

Type(s)

\Joomla\Session\Storage

Security policy.

List of checks that will be done.

Default values:

fix_browser
fix_adress

since	1.0

Type(s)

array

Force cookies to be SSL only Default false

since	1.0

Type(s)

boolean

The domain to use when setting cookies.

deprecated

since	1.0
deprecated	2.0

Type(s)

mixed

The path to use when setting cookies.

deprecated

since	1.0
deprecated	2.0

Type(s)

mixed

The configuration of the HttpOnly cookie.

deprecated

since	1.5.0
deprecated	2.0

Type(s)

mixed

The configuration of the SameSite cookie.

deprecated

since	1.5.0
deprecated	2.0

Type(s)

mixed

Session instances container.

static deprecated

since	1.0
deprecated	2.0

Type(s)

\Joomla\Session\Session

The type of storage for the session.

deprecated

since	1.0
deprecated	2.0

Type(s)

string

Holds the Input object

since	1.0

Type(s)

\Joomla\Input\Input

Holds the Dispatcher object

since	1.0

Type(s)

\Joomla\Event\DispatcherInterface

Session

Methods

__construct

Arguments

__get

Arguments

Response

_createToken

Arguments

Response

_setCookieParams

_setCounter

Response

_setOptions

Arguments

Response

_setTimers

Response

_start

Response

_validate

Arguments

Response

clear

Arguments

Response

close

createToken

Arguments

Response

destroy

Response

fork

Response

get

Arguments

Response

getExpire

Response

getId

Response

getInstance

Arguments

Response

getIterator

Response

getName

Response

getState

Response

getStores

Response

getToken

Arguments

Response

has

Arguments

Response

hasToken

Arguments

Response

initialise

Arguments

isActive

Response

isNew

Response

restart

Response

set

Arguments

Response

setCounter

Response

setExpire

Arguments

Response

setOptions

Arguments

Response