Session based persistent storage for authenticated user record.
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
Default configuration for this class.
\Cake\Http\Session
Session object.
\ArrayAccess|array|false|null
User record.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
__construct(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response, array $config)
Constructor.
\Cake\Http\ServerRequest
$request Request instance.
\Cake\Http\Response
$response Response instance.
array
$config optional Configuration list.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
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.
Cake\Core\Exception\Exception
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
delete()
Delete user record from session.
The session id is also renewed to help mitigate issues with session replays.
getConfig(?string $key, mixed $default)
Returns the config.
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');
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.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
read()
Read user record from session.
\ArrayAccess|array|null
User record if available else null.
redirectUrl(mixed $url)
Get/set redirect URL.
mixed
$url optional Redirect URL. If null
returns current URL. If false
deletes currently set URL.
string|array|null
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
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.
$this
Cake\Core\Exception\Exception
write(mixed $user)
Write user record to session.
The session id is also renewed to help mitigate issues with session replays.
array|\ArrayAccess
$user User record.
Runtime config
array
Whether the config property has already been configured with defaults
bool
Default configuration for this class.
Keys:
key
- Session key used to store user record.redirect
- Session key used to store redirect URL.array
Session object.
\Cake\Http\Session
User record.
Stores user record array if fetched from session or false if session does not have user record.
\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