接口 EventInterface
表示系统中事件的传输类。它接收一个名称、主题和一个可选的负载。名称可以是任何字符串,它在整个应用程序中唯一地标识事件,而主题表示事件适用的对象。
命名空间: Cake\Event
方法摘要
-
getData() public
访问事件数据/负载。
-
getName() public
返回此事件的名称。这通常用作事件标识符。
-
getResult() public
事件监听器的结果值。
-
getSubject() public
返回此事件的主题。
-
isStopped() public
检查事件是否已停止。
-
setData() public
为该事件的数据/负载分配一个值。
-
setResult() public
监听器可以将结果值附加到事件。
-
stopPropagation() public
停止事件被进一步使用。
方法详情
getData() ¶ public
getData(string|null $key = null): mixed
访问事件数据/负载。
参数
-
string|null
$key 可选 要返回的数据负载元素,或 null 以返回所有数据。
返回值
mixed
setData() ¶ public
setData(array|string $key, mixed $value = null): $this
为该事件的数据/负载分配一个值。
参数
-
array|string
$key 数组将替换所有负载数据,而键将只设置该数组项。
-
mixed
$value 可选 要设置的值。
返回值
$this
setResult() ¶ public
setResult(mixed $value = null): $this
监听器可以将结果值附加到事件。
参数
-
mixed
$value 可选 要设置的值。
返回值
$this