类事件
类事件
命名空间: Cake\Event
属性摘要
方法摘要
-
__construct() 公共
构造函数
-
getData() 公共
访问事件数据/有效负载。
-
getName() 公共
返回此事件的名称。这通常用作事件标识符
-
getResult() 公共
事件监听器的结果值
-
getSubject() 公共
返回此事件的主题
-
isStopped() 公共
检查事件是否已停止
-
setData() 公共
为此事件的数据/有效负载分配一个值。
-
setResult() 公共
监听器可以将结果值附加到事件。
-
stopPropagation() 公共
停止事件被再次使用
方法详细说明
__construct() ¶ 公共
__construct(string $name, object|null $subject = null, array $data = [])
构造函数
使用示例
$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
$event = new Event('User.afterRegister', $userModel);
参数
-
字符串
$name 事件的名称
-
对象|null
$subject 可选 此事件适用的对象(通常是生成事件的对象)。
-
数组
$data 可选 您希望与该事件一起传输的任何值,以便监听器可以读取它。
getSubject() ¶ 公共
getSubject(): object
返回此事件的主题
如果事件没有主题,将抛出异常。
返回
对象
抛出
Cake\Core\Exception\CakeException
setData() ¶ 公共
setData(array|string $key, mixed $value = null): $this
为此事件的数据/有效负载分配一个值。
参数
-
数组|字符串
$key -
混合
$value 可选
返回
$this
setResult() ¶ 公共
setResult(mixed $value = null): $this
监听器可以将结果值附加到事件。
参数
-
混合
$value 可选 要设置的值。
返回
$this