-
-
Notifications
You must be signed in to change notification settings - Fork 51
/
AbstractAdapter.php
1565 lines (1381 loc) · 43.2 KB
/
AbstractAdapter.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
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
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* @see https://github.com/laminas/laminas-cache for the canonical source repository
* @copyright https://github.com/laminas/laminas-cache/blob/master/COPYRIGHT.md
* @license https://github.com/laminas/laminas-cache/blob/master/LICENSE.md New BSD License
*/
namespace Laminas\Cache\Storage\Adapter;
use ArrayObject;
use Laminas\Cache\Exception;
use Laminas\Cache\Storage\Capabilities;
use Laminas\Cache\Storage\Event;
use Laminas\Cache\Storage\ExceptionEvent;
use Laminas\Cache\Storage\Plugin;
use Laminas\Cache\Storage\PluginAwareInterface;
use Laminas\Cache\Storage\PostEvent;
use Laminas\Cache\Storage\StorageInterface;
use Laminas\EventManager\EventManager;
use Laminas\EventManager\EventManagerInterface;
use SplObjectStorage;
use stdClass;
use Traversable;
abstract class AbstractAdapter implements StorageInterface, PluginAwareInterface
{
/**
* The used EventManager if any
*
* @var null|EventManagerInterface
*/
protected $events = null;
/**
* Event handles of this adapter
* @var array
*/
protected $eventHandles = [];
/**
* The plugin registry
*
* @var SplObjectStorage Registered plugins
*/
protected $pluginRegistry;
/**
* Capabilities of this adapter
*
* @var null|Capabilities
*/
protected $capabilities = null;
/**
* Marker to change capabilities
*
* @var null|object
*/
protected $capabilityMarker;
/**
* options
*
* @var mixed
*/
protected $options;
/**
* Constructor
*
* @param null|array|Traversable|AdapterOptions $options
* @throws Exception\ExceptionInterface
*/
public function __construct($options = null)
{
if ($options) {
$this->setOptions($options);
}
}
/**
* Destructor
*
* detach all registered plugins to free
* event handles of event manager
*
* @return void
*/
public function __destruct()
{
foreach ($this->getPluginRegistry() as $plugin) {
$this->removePlugin($plugin);
}
if ($this->eventHandles) {
$events = $this->getEventManager();
foreach ($this->eventHandles as $handle) {
$events->detach($handle);
}
}
}
/* configuration */
/**
* Set options.
*
* @param array|Traversable|AdapterOptions $options
* @return AbstractAdapter Provides a fluent interface
* @see getOptions()
*/
public function setOptions($options)
{
if ($this->options !== $options) {
if (! $options instanceof AdapterOptions) {
$options = new AdapterOptions($options);
}
if ($this->options) {
$this->options->setAdapter(null);
}
$options->setAdapter($this);
$this->options = $options;
$event = new Event('option', $this, new ArrayObject($options->toArray()));
$this->getEventManager()->triggerEvent($event);
}
return $this;
}
/**
* Get options.
*
* @return AdapterOptions
* @see setOptions()
*/
public function getOptions()
{
if (! $this->options) {
$this->setOptions(new AdapterOptions());
}
return $this->options;
}
/**
* Enable/Disable caching.
*
* Alias of setWritable and setReadable.
*
* @see setWritable()
* @see setReadable()
* @param bool $flag
* @return AbstractAdapter Provides a fluent interface
*/
public function setCaching($flag)
{
$flag = (bool) $flag;
$options = $this->getOptions();
$options->setWritable($flag);
$options->setReadable($flag);
return $this;
}
/**
* Get caching enabled.
*
* Alias of getWritable and getReadable.
*
* @see getWritable()
* @see getReadable()
* @return bool
*/
public function getCaching()
{
$options = $this->getOptions();
return ($options->getWritable() && $options->getReadable());
}
/* Event/Plugin handling */
/**
* Get the event manager
*
* @return EventManagerInterface
*/
public function getEventManager()
{
if ($this->events === null) {
$this->events = new EventManager();
$this->events->setIdentifiers([__CLASS__, get_class($this)]);
}
return $this->events;
}
/**
* Trigger a pre event and return the event response collection
*
* @param string $eventName
* @param ArrayObject $args
* @return \Laminas\EventManager\ResponseCollection All handler return values
*/
protected function triggerPre($eventName, ArrayObject $args)
{
return $this->getEventManager()->triggerEvent(new Event($eventName . '.pre', $this, $args));
}
/**
* Triggers the PostEvent and return the result value.
*
* @param string $eventName
* @param ArrayObject $args
* @param mixed $result
* @return mixed
*/
protected function triggerPost($eventName, ArrayObject $args, & $result)
{
$postEvent = new PostEvent($eventName . '.post', $this, $args, $result);
$eventRs = $this->getEventManager()->triggerEvent($postEvent);
return $eventRs->stopped()
? $eventRs->last()
: $postEvent->getResult();
}
/**
* Trigger an exception event
*
* If the ExceptionEvent has the flag "throwException" enabled throw the
* exception after trigger else return the result.
*
* @param string $eventName
* @param ArrayObject $args
* @param mixed $result
* @param \Exception $exception
* @throws Exception\ExceptionInterface
* @return mixed
*/
protected function triggerException($eventName, ArrayObject $args, & $result, \Exception $exception)
{
$exceptionEvent = new ExceptionEvent($eventName . '.exception', $this, $args, $result, $exception);
$eventRs = $this->getEventManager()->triggerEvent($exceptionEvent);
if ($exceptionEvent->getThrowException()) {
throw $exceptionEvent->getException();
}
return $eventRs->stopped()
? $eventRs->last()
: $exceptionEvent->getResult();
}
/**
* {@inheritdoc}
*/
public function hasPlugin(Plugin\PluginInterface $plugin)
{
$registry = $this->getPluginRegistry();
return $registry->contains($plugin);
}
/**
* {@inheritdoc}
*/
public function addPlugin(Plugin\PluginInterface $plugin, $priority = 1)
{
$registry = $this->getPluginRegistry();
if ($registry->contains($plugin)) {
throw new Exception\LogicException(sprintf(
'Plugin of type "%s" already registered',
get_class($plugin)
));
}
$plugin->attach($this->getEventManager(), $priority);
$registry->attach($plugin);
return $this;
}
/**
* {@inheritdoc}
*/
public function removePlugin(Plugin\PluginInterface $plugin)
{
$registry = $this->getPluginRegistry();
if ($registry->contains($plugin)) {
$plugin->detach($this->getEventManager());
$registry->detach($plugin);
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getPluginRegistry()
{
if (! $this->pluginRegistry instanceof SplObjectStorage) {
$this->pluginRegistry = new SplObjectStorage();
}
return $this->pluginRegistry;
}
/* reading */
/**
* Get an item.
*
* @param string $key
* @param bool $success
* @param mixed $casToken
* @return mixed Data on success, null on failure
* @throws Exception\ExceptionInterface
*
* @triggers getItem.pre(PreEvent)
* @triggers getItem.post(PostEvent)
* @triggers getItem.exception(ExceptionEvent)
*/
public function getItem($key, & $success = null, & $casToken = null)
{
if (! $this->getOptions()->getReadable()) {
$success = false;
return;
}
$this->normalizeKey($key);
$argn = func_num_args();
$args = [
'key' => & $key,
];
if ($argn > 1) {
$args['success'] = & $success;
}
if ($argn > 2) {
$args['casToken'] = & $casToken;
}
$args = new ArrayObject($args);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
if ($eventRs->stopped()) {
$result = $eventRs->last();
} elseif ($args->offsetExists('success') && $args->offsetExists('casToken')) {
$result = $this->internalGetItem($args['key'], $args['success'], $args['casToken']);
} elseif ($args->offsetExists('success')) {
$result = $this->internalGetItem($args['key'], $args['success']);
} else {
$result = $this->internalGetItem($args['key']);
}
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = null;
$success = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to get an item.
*
* @param string $normalizedKey
* @param bool $success
* @param mixed $casToken
* @return mixed Data on success, null on failure
* @throws Exception\ExceptionInterface
*/
abstract protected function internalGetItem(& $normalizedKey, & $success = null, & $casToken = null);
/**
* Get multiple items.
*
* @param array $keys
* @return array Associative array of keys and values
* @throws Exception\ExceptionInterface
*
* @triggers getItems.pre(PreEvent)
* @triggers getItems.post(PostEvent)
* @triggers getItems.exception(ExceptionEvent)
*/
public function getItems(array $keys)
{
if (! $this->getOptions()->getReadable()) {
return [];
}
$this->normalizeKeys($keys);
$args = new ArrayObject([
'keys' => & $keys,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalGetItems($args['keys']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = [];
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to get multiple items.
*
* @param array $normalizedKeys
* @return array Associative array of keys and values
* @throws Exception\ExceptionInterface
*/
protected function internalGetItems(array & $normalizedKeys)
{
$success = null;
$result = [];
foreach ($normalizedKeys as $normalizedKey) {
$value = $this->internalGetItem($normalizedKey, $success);
if ($success) {
$result[$normalizedKey] = $value;
}
}
return $result;
}
/**
* Test if an item exists.
*
* @param string $key
* @return bool
* @throws Exception\ExceptionInterface
*
* @triggers hasItem.pre(PreEvent)
* @triggers hasItem.post(PostEvent)
* @triggers hasItem.exception(ExceptionEvent)
*/
public function hasItem($key)
{
if (! $this->getOptions()->getReadable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'key' => & $key,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalHasItem($args['key']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to test if an item exists.
*
* @param string $normalizedKey
* @return bool
* @throws Exception\ExceptionInterface
*/
protected function internalHasItem(& $normalizedKey)
{
$success = null;
$this->internalGetItem($normalizedKey, $success);
return $success;
}
/**
* Test multiple items.
*
* @param array $keys
* @return array Array of found keys
* @throws Exception\ExceptionInterface
*
* @triggers hasItems.pre(PreEvent)
* @triggers hasItems.post(PostEvent)
* @triggers hasItems.exception(ExceptionEvent)
*/
public function hasItems(array $keys)
{
if (! $this->getOptions()->getReadable()) {
return [];
}
$this->normalizeKeys($keys);
$args = new ArrayObject([
'keys' => & $keys,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalHasItems($args['keys']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = [];
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to test multiple items.
*
* @param array $normalizedKeys
* @return array Array of found keys
* @throws Exception\ExceptionInterface
*/
protected function internalHasItems(array & $normalizedKeys)
{
$result = [];
foreach ($normalizedKeys as $normalizedKey) {
if ($this->internalHasItem($normalizedKey)) {
$result[] = $normalizedKey;
}
}
return $result;
}
/**
* Get metadata of an item.
*
* @param string $key
* @return array|bool Metadata on success, false on failure
* @throws Exception\ExceptionInterface
*
* @triggers getMetadata.pre(PreEvent)
* @triggers getMetadata.post(PostEvent)
* @triggers getMetadata.exception(ExceptionEvent)
*/
public function getMetadata($key)
{
if (! $this->getOptions()->getReadable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'key' => & $key,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalGetMetadata($args['key']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to get metadata of an item.
*
* @param string $normalizedKey
* @return array|bool Metadata on success, false on failure
* @throws Exception\ExceptionInterface
*/
protected function internalGetMetadata(& $normalizedKey)
{
if (! $this->internalHasItem($normalizedKey)) {
return false;
}
return [];
}
/**
* Get multiple metadata
*
* @param array $keys
* @return array Associative array of keys and metadata
* @throws Exception\ExceptionInterface
*
* @triggers getMetadatas.pre(PreEvent)
* @triggers getMetadatas.post(PostEvent)
* @triggers getMetadatas.exception(ExceptionEvent)
*/
public function getMetadatas(array $keys)
{
if (! $this->getOptions()->getReadable()) {
return [];
}
$this->normalizeKeys($keys);
$args = new ArrayObject([
'keys' => & $keys,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalGetMetadatas($args['keys']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = [];
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to get multiple metadata
*
* @param array $normalizedKeys
* @return array Associative array of keys and metadata
* @throws Exception\ExceptionInterface
*/
protected function internalGetMetadatas(array & $normalizedKeys)
{
$result = [];
foreach ($normalizedKeys as $normalizedKey) {
$metadata = $this->internalGetMetadata($normalizedKey);
if ($metadata !== false) {
$result[$normalizedKey] = $metadata;
}
}
return $result;
}
/* writing */
/**
* Store an item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*
* @triggers setItem.pre(PreEvent)
* @triggers setItem.post(PostEvent)
* @triggers setItem.exception(ExceptionEvent)
*/
public function setItem($key, $value)
{
if (! $this->getOptions()->getWritable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'key' => & $key,
'value' => & $value,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalSetItem($args['key'], $args['value']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to store an item.
*
* @param string $normalizedKey
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*/
abstract protected function internalSetItem(& $normalizedKey, & $value);
/**
* Store multiple items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*
* @triggers setItems.pre(PreEvent)
* @triggers setItems.post(PostEvent)
* @triggers setItems.exception(ExceptionEvent)
*/
public function setItems(array $keyValuePairs)
{
if (! $this->getOptions()->getWritable()) {
return array_keys($keyValuePairs);
}
$this->normalizeKeyValuePairs($keyValuePairs);
$args = new ArrayObject([
'keyValuePairs' => & $keyValuePairs,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalSetItems($args['keyValuePairs']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = array_keys($keyValuePairs);
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to store multiple items.
*
* @param array $normalizedKeyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*/
protected function internalSetItems(array & $normalizedKeyValuePairs)
{
$failedKeys = [];
foreach ($normalizedKeyValuePairs as $normalizedKey => $value) {
if (! $this->internalSetItem($normalizedKey, $value)) {
$failedKeys[] = $normalizedKey;
}
}
return $failedKeys;
}
/**
* Add an item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*
* @triggers addItem.pre(PreEvent)
* @triggers addItem.post(PostEvent)
* @triggers addItem.exception(ExceptionEvent)
*/
public function addItem($key, $value)
{
if (! $this->getOptions()->getWritable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'key' => & $key,
'value' => & $value,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalAddItem($args['key'], $args['value']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to add an item.
*
* @param string $normalizedKey
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*/
protected function internalAddItem(& $normalizedKey, & $value)
{
if ($this->internalHasItem($normalizedKey)) {
return false;
}
return $this->internalSetItem($normalizedKey, $value);
}
/**
* Add multiple items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*
* @triggers addItems.pre(PreEvent)
* @triggers addItems.post(PostEvent)
* @triggers addItems.exception(ExceptionEvent)
*/
public function addItems(array $keyValuePairs)
{
if (! $this->getOptions()->getWritable()) {
return array_keys($keyValuePairs);
}
$this->normalizeKeyValuePairs($keyValuePairs);
$args = new ArrayObject([
'keyValuePairs' => & $keyValuePairs,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalAddItems($args['keyValuePairs']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = array_keys($keyValuePairs);
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to add multiple items.
*
* @param array $normalizedKeyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*/
protected function internalAddItems(array & $normalizedKeyValuePairs)
{
$result = [];
foreach ($normalizedKeyValuePairs as $normalizedKey => $value) {
if (! $this->internalAddItem($normalizedKey, $value)) {
$result[] = $normalizedKey;
}
}
return $result;
}
/**
* Replace an existing item.
*
* @param string $key
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*
* @triggers replaceItem.pre(PreEvent)
* @triggers replaceItem.post(PostEvent)
* @triggers replaceItem.exception(ExceptionEvent)
*/
public function replaceItem($key, $value)
{
if (! $this->getOptions()->getWritable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'key' => & $key,
'value' => & $value,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalReplaceItem($args['key'], $args['value']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to replace an existing item.
*
* @param string $normalizedKey
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
*/
protected function internalReplaceItem(& $normalizedKey, & $value)
{
if (! $this->internalhasItem($normalizedKey)) {
return false;
}
return $this->internalSetItem($normalizedKey, $value);
}
/**
* Replace multiple existing items.
*
* @param array $keyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*
* @triggers replaceItems.pre(PreEvent)
* @triggers replaceItems.post(PostEvent)
* @triggers replaceItems.exception(ExceptionEvent)
*/
public function replaceItems(array $keyValuePairs)
{
if (! $this->getOptions()->getWritable()) {
return array_keys($keyValuePairs);
}
$this->normalizeKeyValuePairs($keyValuePairs);
$args = new ArrayObject([
'keyValuePairs' => & $keyValuePairs,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalReplaceItems($args['keyValuePairs']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = array_keys($keyValuePairs);
return $this->triggerException(__FUNCTION__, $args, $result, $e);
}
}
/**
* Internal method to replace multiple existing items.
*
* @param array $normalizedKeyValuePairs
* @return array Array of not stored keys
* @throws Exception\ExceptionInterface
*/
protected function internalReplaceItems(array & $normalizedKeyValuePairs)
{
$result = [];
foreach ($normalizedKeyValuePairs as $normalizedKey => $value) {
if (! $this->internalReplaceItem($normalizedKey, $value)) {
$result[] = $normalizedKey;
}
}
return $result;
}
/**
* Set an item only if token matches
*
* It uses the token received from getItem() to check if the item has
* changed before overwriting it.
*
* @param mixed $token
* @param string $key
* @param mixed $value
* @return bool
* @throws Exception\ExceptionInterface
* @see getItem()
* @see setItem()
*/
public function checkAndSetItem($token, $key, $value)
{
if (! $this->getOptions()->getWritable()) {
return false;
}
$this->normalizeKey($key);
$args = new ArrayObject([
'token' => & $token,
'key' => & $key,
'value' => & $value,
]);
try {
$eventRs = $this->triggerPre(__FUNCTION__, $args);
$result = $eventRs->stopped()
? $eventRs->last()
: $this->internalCheckAndSetItem($args['token'], $args['key'], $args['value']);
return $this->triggerPost(__FUNCTION__, $args, $result);
} catch (\Exception $e) {
$result = false;
return $this->triggerException(__FUNCTION__, $args, $result, $e);