-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathCacheAfterAddEvent.php
More file actions
119 lines (105 loc) · 2.95 KB
/
Copy pathCacheAfterAddEvent.php
File metadata and controls
119 lines (105 loc) · 2.95 KB
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
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 5.3.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Cache\Event;
use Cake\Cache\CacheEngine;
use Cake\Cache\Exception\InvalidArgumentException;
use Cake\Event\Event;
use DateInterval;
/**
* Class Cache AfterAdd Event
*
* @template TEngine of \Cake\Cache\CacheEngine
* @extends \Cake\Event\Event<TEngine>
*/
class CacheAfterAddEvent extends Event
{
public const NAME = 'Cache.afterAdd';
protected string $key;
protected mixed $value = null;
protected DateInterval|int|null $ttl = null;
/**
* Constructor
*
* @param string $name Name of the event
* @param TEngine $subject The Cache engine instance this event applies to.
* @param array $data Any value you wish to be transported with this event to it can be read by listeners.
*/
public function __construct(string $name, CacheEngine $subject, array $data = [])
{
if (isset($data['key'])) {
$this->key = $data['key'];
unset($data['key']);
}
if (isset($data['value'])) {
$this->value = $data['value'];
unset($data['value']);
}
if (isset($data['success'])) {
$this->result = $data['success'];
unset($data['success']);
}
if (isset($data['ttl'])) {
$this->ttl = $data['ttl'];
unset($data['ttl']);
}
parent::__construct($name, $subject, $data);
}
/**
* The result value of the event listeners
*
* @return bool|null
*/
public function getResult(): ?bool
{
return $this->result;
}
/**
* Listeners can attach a result value to the event.
*
* @param mixed $value The value to set.
* @return $this
*/
public function setResult(mixed $value = null)
{
if ($value !== null && !is_bool($value)) {
throw new InvalidArgumentException(
'The result for CacheEngine events must be a `bool`.',
);
}
return parent::setResult($value);
}
/**
* @return string
*/
public function getKey(): string
{
return $this->key;
}
/**
* @return mixed
*/
public function getValue(): mixed
{
return $this->value;
}
/**
* @return \DateInterval|int|null
*/
public function getTtl(): DateInterval|int|null
{
return $this->ttl;
}
}