Class SessionStorage

Session based persistent storage for authenticated user record.

Namespace: Cake\Auth\Storage

Properties summary

  • $_config protected
    array

    Runtime config

  • bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    Default configuration for this class.

  • $_session protected
    \Cake\Http\Session

    Session object.

  • $_user protected
    \ArrayAccess|array|false|null

    User record.

Method Summary

Method Detail

__construct() 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.

_configDelete() 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() protected

_configRead(?string $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected

_configWrite(mixed $key, mixed $value, mixed $merge)

Writes a config key.

Parameters

string|array $key

Key to write to.

mixed $value

Value to write.

bool|string $merge optional

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

configShallow() public

configShallow(mixed $key, mixed $value)

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

The value to set.

Returns

$this

delete() public

delete()

Delete user record from session.

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

getConfig() public

getConfig(?string $key, mixed $default)

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

The key to get or null for the whole config.

mixed $default optional

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.

getConfigOrFail() public

getConfigOrFail(string $key)

Returns the config for this specific key.

The config value for this key must exist, it can never be null.

Parameters

string $key

The key to get.

Returns

mixed

Configuration data at the named key

Throws

InvalidArgumentException

read() public

read()

Read user record from session.

Returns

\ArrayAccess|array|null

User record if available else null.

redirectUrl() public

redirectUrl(mixed $url)

Get/set redirect URL.

Parameters

mixed $url optional

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

Returns

string|array|null

setConfig() public

setConfig(mixed $key, mixed $value, mixed $merge)

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

The value to set.

bool $merge optional

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.

write() public

write(mixed $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.

Property Detail

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

Default configuration for this class.

Keys:

  • key - Session key used to store user record.
  • redirect - Session key used to store redirect URL.

Type

array

$_session protected

Session object.

Type

\Cake\Http\Session

$_user protected

User record.

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

Type

\ArrayAccess|array|false|null

© 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/4.1/class-Cake.Auth.Storage.SessionStorage.html