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
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
<?php
/**
* Zend Framework (http://framework.zend.com/)
*
* @link http://github.com/zendframework/zf2 for the canonical source repository
* @copyright Copyright (c) 2005-2016 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
namespace Zend\Cache\Storage;
use ArrayObject;
use stdClass;
use Zend\Cache\Exception;
use Zend\EventManager\EventsCapableInterface;
class Capabilities
{
/**
* The storage instance
*
* @var StorageInterface
*/
protected $storage;
/**
* A marker to set/change capabilities
*
* @var stdClass
*/
protected $marker;
/**
* Base capabilities
*
* @var null|Capabilities
*/
protected $baseCapabilities;
/**
* "lock-on-expire" support in seconds.
*
* 0 = Expired items will never be retrieved
* >0 = Time in seconds an expired item could be retrieved
* -1 = Expired items could be retrieved forever
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|bool
*/
protected $lockOnExpire;
/**
* Max. key length
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|int
*/
protected $maxKeyLength;
/**
* Min. TTL (0 means items never expire)
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|int
*/
protected $minTtl;
/**
* Max. TTL (0 means infinite)
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|int
*/
protected $maxTtl;
/**
* Namespace is prefix
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|bool
*/
protected $namespaceIsPrefix;
/**
* Namespace separator
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|string
*/
protected $namespaceSeparator;
/**
* Static ttl
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|bool
*/
protected $staticTtl;
/**
* Supported datatypes
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|array
*/
protected $supportedDatatypes;
/**
* Supported metadata
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|array
*/
protected $supportedMetadata;
/**
* TTL precision
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|int
*/
protected $ttlPrecision;
/**
* Use request time
*
* If it's NULL the capability isn't set and the getter
* returns the base capability or the default value.
*
* @var null|bool
*/
protected $useRequestTime;
/**
* Constructor
*
* @param StorageInterface $storage
* @param stdClass $marker
* @param array $capabilities
* @param null|Capabilities $baseCapabilities
*/
public function __construct(
StorageInterface $storage,
stdClass $marker,
array $capabilities = [],
Capabilities $baseCapabilities = null
) {
$this->storage = $storage;
$this->marker = $marker;
$this->baseCapabilities = $baseCapabilities;
foreach ($capabilities as $name => $value) {
$this->setCapability($marker, $name, $value);
}
}
/**
* Get the storage adapter
*
* @return StorageInterface
*/
public function getAdapter()
{
return $this->storage;
}
/**
* Get supported datatypes
*
* @return array
*/
public function getSupportedDatatypes()
{
return $this->getCapability('supportedDatatypes', [
'NULL' => false,
'boolean' => false,
'integer' => false,
'double' => false,
'string' => true,
'array' => false,
'object' => false,
'resource' => false,
]);
}
/**
* Set supported datatypes
*
* @param stdClass $marker
* @param array $datatypes
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setSupportedDatatypes(stdClass $marker, array $datatypes)
{
$allTypes = [
'array',
'boolean',
'double',
'integer',
'NULL',
'object',
'resource',
'string',
];
// check/normalize datatype values
foreach ($datatypes as $type => &$toType) {
if (! in_array($type, $allTypes)) {
throw new Exception\InvalidArgumentException("Unknown datatype '{$type}'");
}
if (is_string($toType)) {
$toType = strtolower($toType);
if (! in_array($toType, $allTypes)) {
throw new Exception\InvalidArgumentException("Unknown datatype '{$toType}'");
}
} else {
$toType = (bool) $toType;
}
}
// add missing datatypes as not supported
$missingTypes = array_diff($allTypes, array_keys($datatypes));
foreach ($missingTypes as $type) {
$datatypes[$type] = false;
}
return $this->setCapability($marker, 'supportedDatatypes', $datatypes);
}
/**
* Get supported metadata
*
* @return array
*/
public function getSupportedMetadata()
{
return $this->getCapability('supportedMetadata', []);
}
/**
* Set supported metadata
*
* @param stdClass $marker
* @param string[] $metadata
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setSupportedMetadata(stdClass $marker, array $metadata)
{
foreach ($metadata as $name) {
if (! is_string($name)) {
throw new Exception\InvalidArgumentException('$metadata must be an array of strings');
}
}
return $this->setCapability($marker, 'supportedMetadata', $metadata);
}
/**
* Get minimum supported time-to-live
*
* @return int 0 means items never expire
*/
public function getMinTtl()
{
return $this->getCapability('minTtl', 0);
}
/**
* Set minimum supported time-to-live
*
* @param stdClass $marker
* @param int $minTtl
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setMinTtl(stdClass $marker, $minTtl)
{
$minTtl = (int) $minTtl;
if ($minTtl < 0) {
throw new Exception\InvalidArgumentException('$minTtl must be greater or equal 0');
}
return $this->setCapability($marker, 'minTtl', $minTtl);
}
/**
* Get maximum supported time-to-live
*
* @return int 0 means infinite
*/
public function getMaxTtl()
{
return $this->getCapability('maxTtl', 0);
}
/**
* Set maximum supported time-to-live
*
* @param stdClass $marker
* @param int $maxTtl
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setMaxTtl(stdClass $marker, $maxTtl)
{
$maxTtl = (int) $maxTtl;
if ($maxTtl < 0) {
throw new Exception\InvalidArgumentException('$maxTtl must be greater or equal 0');
}
return $this->setCapability($marker, 'maxTtl', $maxTtl);
}
/**
* Is the time-to-live handled static (on write)
* or dynamic (on read)
*
* @return bool
*/
public function getStaticTtl()
{
return $this->getCapability('staticTtl', false);
}
/**
* Set if the time-to-live handled static (on write) or dynamic (on read)
*
* @param stdClass $marker
* @param bool $flag
* @return Capabilities Fluent interface
*/
public function setStaticTtl(stdClass $marker, $flag)
{
return $this->setCapability($marker, 'staticTtl', (bool) $flag);
}
/**
* Get time-to-live precision
*
* @return float
*/
public function getTtlPrecision()
{
return $this->getCapability('ttlPrecision', 1);
}
/**
* Set time-to-live precision
*
* @param stdClass $marker
* @param float $ttlPrecision
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setTtlPrecision(stdClass $marker, $ttlPrecision)
{
$ttlPrecision = (float) $ttlPrecision;
if ($ttlPrecision <= 0) {
throw new Exception\InvalidArgumentException('$ttlPrecision must be greater than 0');
}
return $this->setCapability($marker, 'ttlPrecision', $ttlPrecision);
}
/**
* Get use request time
*
* @return bool
*/
public function getUseRequestTime()
{
return $this->getCapability('useRequestTime', false);
}
/**
* Set use request time
*
* @param stdClass $marker
* @param bool $flag
* @return Capabilities Fluent interface
*/
public function setUseRequestTime(stdClass $marker, $flag)
{
return $this->setCapability($marker, 'useRequestTime', (bool) $flag);
}
/**
* Get if expired items are readable
*
* @return bool
* @deprecated This capability has been deprecated and will be removed in the future.
* Please use getStaticTtl() instead
*/
public function getExpiredRead()
{
trigger_error(
'This capability has been deprecated and will be removed in the future. Please use static_ttl instead',
E_USER_DEPRECATED
);
return ! $this->getCapability('staticTtl', true);
}
/**
* Set if expired items are readable
*
* @param stdClass $marker
* @param bool $flag
* @return Capabilities Fluent interface
* @deprecated This capability has been deprecated and will be removed in the future.
* Please use setStaticTtl() instead
*/
public function setExpiredRead(stdClass $marker, $flag)
{
trigger_error(
'This capability has been deprecated and will be removed in the future. Please use static_ttl instead',
E_USER_DEPRECATED
);
return $this->setCapability($marker, 'staticTtl', (bool) $flag);
}
/**
* Get "lock-on-expire" support in seconds.
*
* @return int 0 = Expired items will never be retrieved
* >0 = Time in seconds an expired item could be retrieved
* -1 = Expired items could be retrieved forever
*/
public function getLockOnExpire()
{
return $this->getCapability('lockOnExpire', 0);
}
/**
* Set "lock-on-expire" support in seconds.
*
* @param stdClass $marker
* @param int $timeout
* @return Capabilities Fluent interface
*/
public function setLockOnExpire(stdClass $marker, $timeout)
{
return $this->setCapability($marker, 'lockOnExpire', (int) $timeout);
}
/**
* Get maximum key length
*
* @return int -1 means unknown, 0 means infinite
*/
public function getMaxKeyLength()
{
return $this->getCapability('maxKeyLength', -1);
}
/**
* Set maximum key length
*
* @param stdClass $marker
* @param int $maxKeyLength
* @throws Exception\InvalidArgumentException
* @return Capabilities Fluent interface
*/
public function setMaxKeyLength(stdClass $marker, $maxKeyLength)
{
$maxKeyLength = (int) $maxKeyLength;
if ($maxKeyLength < -1) {
throw new Exception\InvalidArgumentException('$maxKeyLength must be greater or equal than -1');
}
return $this->setCapability($marker, 'maxKeyLength', $maxKeyLength);
}
/**
* Get if namespace support is implemented as prefix
*
* @return bool
*/
public function getNamespaceIsPrefix()
{
return $this->getCapability('namespaceIsPrefix', true);
}
/**
* Set if namespace support is implemented as prefix
*
* @param stdClass $marker
* @param bool $flag
* @return Capabilities Fluent interface
*/
public function setNamespaceIsPrefix(stdClass $marker, $flag)
{
return $this->setCapability($marker, 'namespaceIsPrefix', (bool) $flag);
}
/**
* Get namespace separator if namespace is implemented as prefix
*
* @return string
*/
public function getNamespaceSeparator()
{
return $this->getCapability('namespaceSeparator', '');
}
/**
* Set the namespace separator if namespace is implemented as prefix
*
* @param stdClass $marker
* @param string $separator
* @return Capabilities Fluent interface
*/
public function setNamespaceSeparator(stdClass $marker, $separator)
{
return $this->setCapability($marker, 'namespaceSeparator', (string) $separator);
}
/**
* Get a capability
*
* @param string $property
* @param mixed $default
* @return mixed
*/
protected function getCapability($property, $default = null)
{
if ($this->$property !== null) {
return $this->$property;
} elseif ($this->baseCapabilities) {
$getMethod = 'get' . $property;
return $this->baseCapabilities->$getMethod();
}
return $default;
}
/**
* Change a capability
*
* @param stdClass $marker
* @param string $property
* @param mixed $value
* @return Capabilities Fluent interface
* @throws Exception\InvalidArgumentException
*/
protected function setCapability(stdClass $marker, $property, $value)
{
if ($this->marker !== $marker) {
throw new Exception\InvalidArgumentException('Invalid marker');
}
if ($this->$property !== $value) {
$this->$property = $value;
// trigger event
if ($this->storage instanceof EventsCapableInterface) {
$this->storage->getEventManager()->trigger('capability', $this->storage, new ArrayObject([
$property => $value
]));
}
}
return $this;
}
}