Session based persistent storage for authenticated user record.
array<string, mixed>
Runtime config
bool
Whether the config property has already been configured with defaults
array<string, mixed>
Default configuration for this class.
Cake\Http\Session
Session object.
ArrayAccess|array|false|null
User record.
Constructor.
Deletes a single config key.
Reads a config key.
Writes a config key.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Delete user record from session.
Returns the config.
Returns the config for this specific key.
Read user record from session.
Get/set redirect URL.
Sets the config.
Write user record to session.
__construct(Cake\Http\ServerRequest $request, Cake\Http\Response $response, array<string, mixed> $config = [])
Constructor.
Cake\Http\ServerRequest
$request Request instance.
Cake\Http\Response
$response Response instance.
array<string, mixed>
$config optional Configuration list.
_configDelete(string $key): void
Deletes a single config key.
string
$key Key to delete.
void
Cake\Core\Exception\CakeException
_configRead(string|null $key): mixed
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string
$key Key to write to.
mixed
$value Value to write.
string|bool
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
void
Cake\Core\Exception\CakeException
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
delete(): void
Delete user record from session.
The session id is also renewed to help mitigate issues with session replays.
void
getConfig(string|null $key = null, mixed $default = null): mixed
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
getConfigOrFail(string $key): mixed
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
InvalidArgumentException
read(): ArrayAccess|array|null
Read user record from session.
ArrayAccess|array|null
redirectUrl(mixed $url = null): array|string|null
Get/set redirect URL.
mixed
$url optional array|string|null
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string
$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\CakeException
write(mixed $user): void
Write user record to session.
The session id is also renewed to help mitigate issues with session replays.
mixed
$user User record.
void
Runtime config
array<string, mixed>
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<string, mixed>
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.4/class-Cake.Auth.Storage.SessionStorage.html