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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Session\Storage;
use ArrayIterator;
use IteratorAggregate;
use Zend\Session\Exception;
/**
* Session storage in $_SESSION
*
* Replaces the $_SESSION superglobal with an ArrayObject that allows for
* property access, metadata storage, locking, and immutability.
*/
abstract class AbstractSessionArrayStorage implements
IteratorAggregate,
StorageInterface,
StorageInitializationInterface
{
/**
* Constructor
*
* @param array|null $input
*/
public function __construct($input = null)
{
// this is here for B.C.
$this->init($input);
}
/**
* Initialize Storage
*
* @param array $input
* @return void
*/
public function init($input = null)
{
if ((null === $input) && isset($_SESSION)) {
$input = $_SESSION;
if (is_object($input) && ! $_SESSION instanceof \ArrayObject) {
$input = (array) $input;
}
} elseif (null === $input) {
$input = [];
}
$_SESSION = $input;
$this->setRequestAccessTime(microtime(true));
}
/**
* Get Offset
*
* @param mixed $key
* @return mixed
*/
public function __get($key)
{
return $this->offsetGet($key);
}
/**
* Set Offset
*
* @param mixed $key
* @param mixed $value
* @return void
*/
public function __set($key, $value)
{
return $this->offsetSet($key, $value);
}
/**
* Isset Offset
*
* @param mixed $key
* @return bool
*/
public function __isset($key)
{
return $this->offsetExists($key);
}
/**
* Unset Offset
*
* @param mixed $key
* @return void
*/
public function __unset($key)
{
return $this->offsetUnset($key);
}
/**
* Destructor
*
* @return void
*/
public function __destruct()
{
return ;
}
/**
* Offset Exists
*
* @param mixed $key
* @return bool
*/
public function offsetExists($key)
{
return isset($_SESSION[$key]);
}
/**
* Offset Get
*
* @param mixed $key
* @return mixed
*/
public function offsetGet($key)
{
if (isset($_SESSION[$key])) {
return $_SESSION[$key];
}
return;
}
/**
* Offset Set
*
* @param mixed $key
* @param mixed $value
* @return void
*/
public function offsetSet($key, $value)
{
$_SESSION[$key] = $value;
}
/**
* Offset Unset
*
* @param mixed $key
* @return void
*/
public function offsetUnset($key)
{
unset($_SESSION[$key]);
}
/**
* Count
*
* @return int
*/
public function count()
{
return count($_SESSION);
}
/**
* Seralize
*
* @return string
*/
public function serialize()
{
return serialize($_SESSION);
}
/**
* Unserialize
*
* @param string $session
* @return mixed
*/
public function unserialize($session)
{
return unserialize($session);
}
/**
* Get Iterator
*
* @return ArrayIterator
*/
public function getIterator()
{
return new ArrayIterator($_SESSION);
}
/**
* Load session object from an existing array
*
* Ensures $_SESSION is set to an instance of the object when complete.
*
* @param array $array
* @return SessionStorage
*/
public function fromArray(array $array)
{
$ts = $this->getRequestAccessTime();
$_SESSION = $array;
$this->setRequestAccessTime($ts);
return $this;
}
/**
* Mark object as isImmutable
*
* @return SessionStorage
*/
public function markImmutable()
{
$_SESSION['_IMMUTABLE'] = true;
return $this;
}
/**
* Determine if this object is isImmutable
*
* @return bool
*/
public function isImmutable()
{
return (isset($_SESSION['_IMMUTABLE']) && $_SESSION['_IMMUTABLE']);
}
/**
* Lock this storage instance, or a key within it
*
* @param null|int|string $key
* @return ArrayStorage
*/
public function lock($key = null)
{
if (null === $key) {
$this->setMetadata('_READONLY', true);
return $this;
}
if (isset($_SESSION[$key])) {
$this->setMetadata('_LOCKS', [$key => true]);
}
return $this;
}
/**
* Is the object or key marked as locked?
*
* @param null|int|string $key
* @return bool
*/
public function isLocked($key = null)
{
if ($this->isImmutable()) {
// isImmutable trumps all
return true;
}
if (null === $key) {
// testing for global lock
return $this->getMetadata('_READONLY');
}
$locks = $this->getMetadata('_LOCKS');
$readOnly = $this->getMetadata('_READONLY');
if ($readOnly && ! $locks) {
// global lock in play; all keys are locked
return true;
}
if ($readOnly && $locks) {
return array_key_exists($key, $locks);
}
// test for individual locks
if (! $locks) {
return false;
}
return array_key_exists($key, $locks);
}
/**
* Unlock an object or key marked as locked
*
* @param null|int|string $key
* @return ArrayStorage
*/
public function unlock($key = null)
{
if (null === $key) {
// Unlock everything
$this->setMetadata('_READONLY', false);
$this->setMetadata('_LOCKS', false);
return $this;
}
$locks = $this->getMetadata('_LOCKS');
if (! $locks) {
if (! $this->getMetadata('_READONLY')) {
return $this;
}
$array = $this->toArray();
$keys = array_keys($array);
$locks = array_flip($keys);
unset($array, $keys);
}
if (array_key_exists($key, $locks)) {
unset($locks[$key]);
$this->setMetadata('_LOCKS', $locks, true);
}
return $this;
}
/**
* Set storage metadata
*
* Metadata is used to store information about the data being stored in the
* object. Some example use cases include:
* - Setting expiry data
* - Maintaining access counts
* - localizing session storage
* - etc.
*
* @param string $key
* @param mixed $value
* @param bool $overwriteArray Whether to overwrite or merge array values; by default, merges
* @return ArrayStorage
* @throws Exception\RuntimeException
*/
public function setMetadata($key, $value, $overwriteArray = false)
{
if ($this->isImmutable()) {
throw new Exception\RuntimeException(
sprintf('Cannot set key "%s" as storage is marked isImmutable', $key)
);
}
if (! isset($_SESSION['__ZF']) || ! is_array($_SESSION['__ZF'])) {
$_SESSION['__ZF'] = [];
}
if (isset($_SESSION['__ZF'][$key]) && is_array($value)) {
if ($overwriteArray) {
$_SESSION['__ZF'][$key] = $value;
} else {
$_SESSION['__ZF'][$key] = array_replace_recursive($_SESSION['__ZF'][$key], $value);
}
} else {
if ((null === $value) && isset($_SESSION['__ZF'][$key])) {
$array = $_SESSION['__ZF'];
unset($array[$key]);
$_SESSION['__ZF'] = $array;
unset($array);
} elseif (null !== $value) {
$_SESSION['__ZF'][$key] = $value;
}
}
return $this;
}
/**
* Retrieve metadata for the storage object or a specific metadata key
*
* Returns false if no metadata stored, or no metadata exists for the given
* key.
*
* @param null|int|string $key
* @return mixed
*/
public function getMetadata($key = null)
{
if (! isset($_SESSION['__ZF'])) {
return false;
}
if (null === $key) {
return $_SESSION['__ZF'];
}
if (! array_key_exists($key, $_SESSION['__ZF'])) {
return false;
}
return $_SESSION['__ZF'][$key];
}
/**
* Clear the storage object or a subkey of the object
*
* @param null|int|string $key
* @return ArrayStorage
* @throws Exception\RuntimeException
*/
public function clear($key = null)
{
if ($this->isImmutable()) {
throw new Exception\RuntimeException('Cannot clear storage as it is marked immutable');
}
if (null === $key) {
$this->fromArray([]);
return $this;
}
if (! isset($_SESSION[$key])) {
return $this;
}
// Clear key data
unset($_SESSION[$key]);
// Clear key metadata
$this->setMetadata($key, null)
->unlock($key);
return $this;
}
/**
* Retrieve the request access time
*
* @return float
*/
public function getRequestAccessTime()
{
return $this->getMetadata('_REQUEST_ACCESS_TIME');
}
/**
* Set the request access time
*
* @param float $time
* @return ArrayStorage
*/
protected function setRequestAccessTime($time)
{
$this->setMetadata('_REQUEST_ACCESS_TIME', $time);
return $this;
}
/**
* Cast the object to an array
*
* @param bool $metaData Whether to include metadata
* @return array
*/
public function toArray($metaData = false)
{
if (isset($_SESSION)) {
$values = $_SESSION;
} else {
$values = [];
}
if ($metaData) {
return $values;
}
if (isset($values['__ZF'])) {
unset($values['__ZF']);
}
return $values;
}
}