/
SessionStorage.php
108 lines (95 loc) · 2.5 KB
/
SessionStorage.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth\Storage;
use Cake\Core\InstanceConfigTrait;
use Cake\Network\Request;
/**
* Session based persistent storage for authenticated user record.
*/
class SessionStorage implements StorageInterface
{
use InstanceConfigTrait;
/**
* User record.
*
* @var array
*/
protected $_user;
/**
* Session object.
*
* @var \Cake\Network\Session
*/
protected $_session;
/**
* Default configuration for this class
*
* @var array
*/
protected $_defaultConfig = [
'key' => 'Auth.User'
];
/**
* Constructor.
*
* @param \Cake\Network\Request $request Request instance.
* @param array $config Configuration list.
*/
public function __construct(Request $request, array $config = [])
{
$this->_session = $request->session();
$this->config($config);
}
/**
* Get user record from session.
*
* @return array|null User record if available else null.
*/
public function get()
{
if ($this->_user) {
return $this->_user;
}
$this->_user = $this->_session->read($this->_config['key']);
return $this->_user;
}
/**
* Set user record to session.
*
* The session id is also renewed to help mitigate issues with session replays.
*
* @param array $user User record.
* @return void
*/
public function set(array $user)
{
$this->_user = $user;
$this->_session->renew();
$this->_session->write($this->_config['key'], $user);
}
/**
* Remove user record from session.
*
* The session id is also renewed to help mitigate issues with session replays.
*
* @return void
*/
public function remove()
{
unset($this->_user);
$this->_session->delete($this->_config['key']);
$this->_session->renew();
}
}