/
Event.php
282 lines (254 loc) · 7.18 KB
/
Event.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
<?php
/**
* 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 2.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Event;
/**
* Class Event
*/
class Event implements EventInterface
{
/**
* Name of the event
*
* @var string
*/
protected $_name;
/**
* The object this event applies to (usually the same object that generates the event)
*
* @var object|null
*/
protected $_subject;
/**
* Custom data for the method that receives the event
*
* @var array
*/
protected $_data;
/**
* Property used to retain the result value of the event listeners
*
* Note: Public access is deprecated, use setResult() and getResult() instead.
*
* @var mixed
*/
public $result;
/**
* Flags an event as stopped or not, default is false
*
* @var bool
*/
protected $_stopped = false;
/**
* Constructor
*
* ### Examples of usage:
*
* ```
* $event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
* $event = new Event('User.afterRegister', $UserModel);
* ```
*
* @param string $name Name of the event
* @param object|null $subject the object that this event applies to (usually the object that is generating the event)
* @param array|\ArrayAccess|null $data any value you wish to be transported with this event to it can be read by listeners
*/
public function __construct($name, $subject = null, $data = null)
{
$this->_name = $name;
$this->_subject = $subject;
$this->_data = (array)$data;
}
/**
* Provides read-only access for the name and subject properties.
*
* @param string $attribute Attribute name.
* @return mixed
* @deprecated 3.4.0 Public properties will be removed.
*/
public function __get($attribute)
{
if (!in_array($attribute, ['name', 'subject', 'data', 'result'])) {
return $this->{$attribute};
}
$method = 'get' . ucfirst($attribute);
deprecationWarning(
"Event::\${$attribute} is deprecated. " .
"Use Event::{$method}() instead."
);
if ($attribute === 'name' || $attribute === 'subject') {
return $this->{$attribute}();
}
if ($attribute === 'data') {
return $this->_data;
}
if ($attribute === 'result') {
return $this->result;
}
}
/**
* Provides backward compatibility for write access to data and result properties.
*
* @param string $attribute Attribute name.
* @param mixed $value The value to set.
* @return void
* @deprecated 3.4.0 Public properties will be removed.
*/
public function __set($attribute, $value)
{
$method = 'set' . ucfirst($attribute);
deprecationWarning(
"Event::\${$attribute} is deprecated. " .
"Use Event::{$method}() instead."
);
if ($attribute === 'data') {
$this->_data = (array)$value;
}
if ($attribute === 'result') {
$this->result = $value;
}
}
/**
* Returns the name of this event. This is usually used as the event identifier
*
* @return string
* @deprecated 3.4.0 use getName() instead.
*/
public function name()
{
deprecationWarning('Event::name() is deprecated. Use Event::getName() instead.');
return $this->_name;
}
/**
* Returns the name of this event. This is usually used as the event identifier
*
* @return string
*/
public function getName()
{
return $this->_name;
}
/**
* Returns the subject of this event
*
* @return object
* @deprecated 3.4.0 use getSubject() instead.
*/
public function subject()
{
deprecationWarning('Event::subject() is deprecated. Use Event::getSubject() instead.');
return $this->_subject;
}
/**
* Returns the subject of this event
*
* @return object
*/
public function getSubject()
{
return $this->_subject;
}
/**
* Stops the event from being used anymore
*
* @return void
*/
public function stopPropagation()
{
$this->_stopped = true;
}
/**
* Check if the event is stopped
*
* @return bool True if the event is stopped
*/
public function isStopped()
{
return $this->_stopped;
}
/**
* The result value of the event listeners
*
* @return mixed
* @deprecated 3.4.0 use getResult() instead.
*/
public function result()
{
deprecationWarning('Event::result() is deprecated. Use Event::getResult() instead.');
return $this->result;
}
/**
* The result value of the event listeners
*
* @return mixed
*/
public function getResult()
{
return $this->result;
}
/**
* Listeners can attach a result value to the event.
*
* @param mixed $value The value to set.
* @return $this
*/
public function setResult($value = null)
{
$this->result = $value;
return $this;
}
/**
* Access the event data/payload.
*
* @param string|null $key The data payload element to return, or null to return all data.
* @return array|mixed|null The data payload if $key is null, or the data value for the given $key. If the $key does not
* exist a null value is returned.
* @deprecated 3.4.0 use getData() instead.
*/
public function data($key = null)
{
deprecationWarning('Event::data() is deprecated. Use Event::getData() instead.');
return $this->getData($key);
}
/**
* Access the event data/payload.
*
* @param string|null $key The data payload element to return, or null to return all data.
* @return array|mixed|null The data payload if $key is null, or the data value for the given $key. If the $key does not
* exist a null value is returned.
*/
public function getData($key = null)
{
if ($key !== null) {
return isset($this->_data[$key]) ? $this->_data[$key] : null;
}
return (array)$this->_data;
}
/**
* Assigns a value to the data/payload of this event.
*
* @param array|string $key An array will replace all payload data, and a key will set just that array item.
* @param mixed $value The value to set.
* @return $this
*/
public function setData($key, $value = null)
{
if (is_array($key)) {
$this->_data = $key;
} else {
$this->_data[$key] = $value;
}
return $this;
}
}