/
Session.php
305 lines (258 loc) · 6.68 KB
/
Session.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\HttpFoundation;
use Symfony\Component\HttpFoundation\SessionStorage\SessionStorageInterface;
/**
* Session.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Session implements \Serializable
{
protected $storage;
protected $attributes;
protected $oldFlashes;
protected $started;
protected $options;
/**
* Constructor.
*
* @param SessionStorageInterface $session A SessionStorageInterface instance
* @param array $options An array of options
*/
public function __construct(SessionStorageInterface $storage, array $options = array())
{
$this->storage = $storage;
$this->options = $options;
$this->attributes = array('_flash' => array(), '_locale' => $this->getDefaultLocale());
$this->started = false;
}
/**
* Starts the session storage.
*/
public function start()
{
if (true === $this->started) {
return;
}
$this->storage->start();
$this->attributes = $this->storage->read('_symfony2');
if (!isset($this->attributes['_flash'])) {
$this->attributes['_flash'] = array();
}
if (!isset($this->attributes['_locale'])) {
$this->attributes['_locale'] = $this->getDefaultLocale();
}
// flag current flash messages to be removed at shutdown
$this->oldFlashes = array_flip(array_keys($this->attributes['_flash']));
$this->started = true;
}
/**
* Checks if an attribute is defined.
*
* @param string $name The attribute name
*
* @return Boolean true if the attribute is defined, false otherwise
*/
public function has($name)
{
return array_key_exists($name, $this->attributes);
}
/**
* Returns an attribute.
*
* @param string $name The attribute name
* @param mixed $default The default value
*
* @return mixed
*/
public function get($name, $default = null)
{
return array_key_exists($name, $this->attributes) ? $this->attributes[$name] : $default;
}
/**
* Sets an attribute.
*
* @param string $name
* @param mixed $value
*/
public function set($name, $value)
{
if (false === $this->started) {
$this->start();
}
$this->attributes[$name] = $value;
}
/**
* Returns attributes.
*
* @return array Attributes
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Sets attributes.
*
* @param array $attributes Attributes
*/
public function setAttributes(array $attributes)
{
if (false === $this->started) {
$this->start();
}
$this->attributes = $attributes;
}
/**
* Removes an attribute.
*
* @param string $name
*/
public function remove($name)
{
if (false === $this->started) {
$this->start();
}
if (array_key_exists($name, $this->attributes)) {
unset($this->attributes[$name]);
}
}
/**
* Clears all attributes.
*/
public function clear()
{
if (false === $this->started) {
$this->start();
}
$this->attributes = array();
}
/**
* Invalidates the current session.
*/
public function invalidate()
{
$this->clear();
$this->storage->regenerate();
}
/**
* Migrates the current session to a new session id while maintaining all
* session attributes.
*/
public function migrate()
{
$this->storage->regenerate();
}
/**
* Returns the session ID
*
* @return mixed The session ID
*/
public function getId()
{
return $this->storage->getId();
}
/**
* Returns the locale
*
* @return string
*/
public function getLocale()
{
return $this->attributes['_locale'];
}
/**
* Sets the locale.
*
* @param string $locale
*/
public function setLocale($locale)
{
if (false === $this->started) {
$this->start();
}
$this->attributes['_locale'] = $locale;
}
public function getFlashes()
{
return isset($this->attributes['_flash']) ? $this->attributes['_flash'] : array();
}
public function setFlashes($values)
{
if (false === $this->started) {
$this->start();
}
$this->attributes['_flash'] = $values;
$this->oldFlashes = array();
}
public function getFlash($name, $default = null)
{
return array_key_exists($name, $this->attributes['_flash']) ? $this->attributes['_flash'][$name] : $default;
}
public function setFlash($name, $value)
{
if (false === $this->started) {
$this->start();
}
$this->attributes['_flash'][$name] = $value;
unset($this->oldFlashes[$name]);
}
public function hasFlash($name)
{
if (false === $this->started) {
$this->start();
}
return array_key_exists($name, $this->attributes['_flash']);
}
public function removeFlash($name)
{
if (false === $this->started) {
$this->start();
}
unset($this->attributes['_flash'][$name]);
}
public function clearFlashes()
{
if (false === $this->started) {
$this->start();
}
$this->attributes['_flash'] = array();
$this->oldFlashes = array();
}
public function save()
{
if (false === $this->started) {
$this->start();
}
if (isset($this->attributes['_flash'])) {
$this->attributes['_flash'] = array_diff_key($this->attributes['_flash'], $this->oldFlashes);
}
$this->storage->write('_symfony2', $this->attributes);
}
public function __destruct()
{
$this->save();
}
public function serialize()
{
return serialize(array($this->storage, $this->options));
}
public function unserialize($serialized)
{
list($this->storage, $this->options) = unserialize($serialized);
$this->attributes = array();
$this->started = false;
}
protected function getDefaultLocale()
{
return isset($this->options['default_locale']) ? $this->options['default_locale'] : 'en';
}
}