W3cubDocs

/CakePHP 3.8

Class SessionStorage

Session based persistent storage for authenticated user record.

Cake\Auth\Storage\SessionStorage implements Cake\Auth\Storage\StorageInterface uses Cake\Core\InstanceConfigTrait

Properties summary

Inherited Properties

Method Summary

Method Detail

__construct()source public

__construct( Cake\Http\ServerRequest $request , Cake\Http\Response $response , array $config = [] )

Constructor.

Parameters

Cake\Http\ServerRequest $request
Request instance.
Cake\Http\Response $response
Response instance.
array $config optional []
Configuration list.

delete()source public

delete( )

Delete user record from session.

The session id is also renewed to help mitigate issues with session replays.

Implementation of

Cake\Auth\Storage\StorageInterface::delete()

read()source public

read( )

Read user record from session.

Returns

array|null
User record if available else null.

Implementation of

Cake\Auth\Storage\StorageInterface::read()

redirectUrl()source public

redirectUrl( mixed $url = null )

Get/set redirect URL.

Parameters

mixed $url optional null

Redirect URL. If null returns current URL. If false deletes currently set URL.

Returns

mixed

Implementation of

Cake\Auth\Storage\StorageInterface::redirectUrl()

write()source public

write( array|ArrayAccess $user )

Write user record to session.

The session id is also renewed to help mitigate issues with session replays.

Parameters

array|ArrayAccess $user
User record.

Implementation of

Cake\Auth\Storage\StorageInterface::write()

Methods used from Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key
Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key
Key to read.

Returns

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge = false )

Writes a config key.

Parameters

string|array $key
Key to write to.
mixed $value
Value to write.
boolean|string $merge optional false

True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

config()source public deprecated

config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )

Gets/Sets the config.

Usage

Reading the whole config:

$this->config();

Reading a specific value:

$this->config('key');

Reading a nested value:

$this->config('some.nested.key');

Setting a specific value:

$this->config('key', $value);

Setting a nested value:

$this->config('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->config(['one' => 'value', 'another' => 'value']);

Deprecated

3.4.0 use setConfig()/getConfig() instead.

Parameters

string|array|null $key optional null
The key to get/set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow()source public

configShallow( string|array $key , mixed|null $value = null )

Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.

Setting a specific value:

$this->configShallow('key', $value);

Setting a nested value:

$this->configShallow('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.

Returns


$this

getConfig()source public

getConfig( string|null $key = null , mixed $default = null )

Returns the config.

Usage

Reading the whole config:

$this->getConfig();

Reading a specific value:

$this->getConfig('key');

Reading a nested value:

$this->getConfig('some.nested.key');

Reading with default value:

$this->getConfig('some-key', 'default-value');

Parameters

string|null $key optional null
The key to get or null for the whole config.
mixed $default optional null
The return value when the key does not exist.

Returns

mixed
Configuration data at the named key or null if the key does not exist.

setConfig()source public

setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )

Sets the config.

Usage

Setting a specific value:

$this->setConfig('key', $value);

Setting a nested value:

$this->setConfig('some.nested.key', $value);

Updating multiple config settings at the same time:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Parameters

string|array $key
The key to set, or a complete array of configs.
mixed|null $value optional null
The value to set.
boolean $merge optional true
Whether to recursively merge or overwrite existing config, defaults to true.

Returns


$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Properties detail

$_defaultConfigsource

protected array

Default configuration for this class.

Keys:

  • key - Session key used to store user record.
  • redirect - Session key used to store redirect URL.
[
    'key' => 'Auth.User',
    'redirect' => 'Auth.redirect'
]

$_sessionsource

protected Cake\Http\Session

Session object.

$_usersource

protected ArrayAccess|array|false

User record.

Stores user record array if fetched from session or false if session does not have user record.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Auth.Storage.SessionStorage.html