Session based persistent storage for authenticated user record.
$_defaultConfig
protected array
$_session
protected $_user
protected array|boolean
__construct( Cake\Network\Request $request , Cake\Network\Response $response , array $config [] )
Constructor.
Cake\Network\Request
$request
Cake\Network\Response
$response
$config
optional [] delete( )
Delete user record from session.
The session id is also renewed to help mitigate issues with session replays.
Cake\Auth\Storage\StorageInterface::delete()
read( )
Read user record from session.
Cake\Auth\Storage\StorageInterface::read()
redirectUrl( mixed $url null )
Get/set redirect URL.
$url
optional null Redirect URL. If null
returns current URL. If false
deletes currently set URL.
Cake\Auth\Storage\StorageInterface::redirectUrl()
write( array $user )
Write user record to session.
The session id is also renewed to help mitigate issues with session replays.
$user
Cake\Auth\Storage\StorageInterface::write()
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
$key
optional null $value
optional null $merge
optional true Cake\Core\Exception\Exception
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']);
$key
$value
optional null 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' ]
protected array|boolean
User record.
Stores user record array if fetched from session or false if session does not have user record.
© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.Auth.Storage.SessionStorage.html