[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Session/ -> Session.php (summary)

Joomla! Content Management System

Copyright: (C) 2005 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 337 lines (11 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

Session:: (9 methods):
  __construct()
  checkToken()
  getFormToken()
  getHandlers()
  getInstance()
  get()
  set()
  has()
  clear()


Class: Session  - X-Ref

Class for managing HTTP sessions

__construct(StorageInterface $store = null, DispatcherInterface $dispatcher = null, array $options = [])   X-Ref
Constructor

param: StorageInterface     $store       A StorageInterface implementation.
param: DispatcherInterface  $dispatcher  DispatcherInterface for the session to use.
param: array                $options     Optional parameters. Supported keys include:

checkToken($method = 'post')   X-Ref
Checks for a form token in the request.

Use in conjunction with HTMLHelper::_('form.token') or JSession::getFormToken.

param: string  $method  The request method in which to look for the token key.
return: boolean  True if found and valid, false otherwise.

getFormToken($forceNew = false)   X-Ref
Method to determine a hash for anti-spoofing variable names

param: boolean  $forceNew  If true, force a new token to be created
return: string  Hashed var name

getHandlers()   X-Ref
Get the available session handlers

return: array  An array of available session handlers

getInstance()   X-Ref
Returns the global session object.

return: static  The Session object.

get($name, $default = null)   X-Ref
Get data from the session store

param: string  $name     Name of a variable
param: mixed   $default  Default value of a variable if not set
return: mixed  Value of a variable

set($name, $value = null)   X-Ref
Set data into the session store.

param: string  $name   Name of a variable.
param: mixed   $value  Value of a variable.
return: mixed  Old value of a variable.

has($name)   X-Ref
Check whether data exists in the session store

param: string  $name  Name of variable
return: boolean  True if the variable exists

clear()   X-Ref
Clears all variables from the session store

return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer