Class SessionStorage

__constructsource public

__construct( Cake\Network\Request $request , Cake\Network\Response $response , array $config [] )

Constructor.

Parameters

Cake\Network\Request $request

Request instance.

Cake\Network\Response $response

Response instance.

array $config optional []

Configuration list.

deletesource 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()

readsource public

read( )

Read user record from session.

Returns

array|null
User record if available else null.

Implementation of

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

redirectUrlsource 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
mixed

Implementation of

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

writesource public

write( array $user )

Write user record to session.

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

Parameters

array $user

User record.

Implementation of

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

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

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

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

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

Write a config variable

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

configsource public

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

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']);

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.

configShallowsource 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->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']);

Parameters

string|array $key

The key to set, or a complete array of configs.

mixed|null $value optional null

The value to set.

Returns

mixed
$this The object itself.

[
    'key' => 'Auth.User',
    'redirect' => 'Auth.redirect'
]

[]

false