CakePHP
  • 文档
    • 书籍
    • API
    • 视频
    • 报告安全问题
    • 隐私政策
    • 标识 & 商标
  • 商业解决方案
  • 周边商品
  • 公路旅行
  • 团队
  • 社区
    • 社区
    • 参与进来
    • 问题 (Github)
    • 面包房
    • 精选资源
    • 培训
    • 聚会
    • 我的CakePHP
    • CakeFest
    • 时事通讯
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • 帮助 & 支持
    • 论坛
    • Stack Overflow
    • IRC
    • Slack
    • 付费支持
CakePHP

C CakePHP 5.1 Chiffon API

  • 项目
    • CakePHP
      • CakePHP
      • Chronos
      • Elastic Search
      • 队列
  • 版本
    • 5.1
      • 5.1
      • 5.0
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

命名空间

  • 全局
  • Cake
    • 缓存
    • 集合
    • 命令
    • 控制台
    • 控制器
    • 核心
    • 数据库
    • 数据源
    • 错误
    • 事件
      • 装饰器
    • 表单
    • Http
    • 国际化
    • 日志
    • 邮件
    • 网络
    • ORM
    • 路由
    • 测试套件
    • 工具
    • 验证
    • 视图

类事件

类事件

命名空间: Cake\Event

属性摘要

  • $_data 受保护的
    数组

    接收事件的方法的自定义数据

  • $_name 受保护的
    字符串

    事件的名称

  • $_stopped 受保护的
    布尔值

    标记事件是否停止,默认值为false

  • $_subject 受保护的
    对象|null

    此事件适用的对象(通常是生成事件的相同对象)

  • $result 受保护的
    混合

    用于保留事件监听器结果值的属性

方法摘要

  • __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 可选

您希望与该事件一起传输的任何值,以便监听器可以读取它。

getData() ¶ 公共

getData(string|null $key = null): mixed

访问事件数据/有效负载。

参数
字符串|null $key 可选
返回
混合

getName() ¶ 公共

getName(): string

返回此事件的名称。这通常用作事件标识符

返回
字符串

getResult() ¶ 公共

getResult(): mixed

事件监听器的结果值

返回
混合

getSubject() ¶ 公共

getSubject(): object

返回此事件的主题

如果事件没有主题,将抛出异常。

返回
对象
抛出
Cake\Core\Exception\CakeException

isStopped() ¶ 公共

isStopped(): bool

检查事件是否已停止

返回
布尔值

setData() ¶ 公共

setData(array|string $key, mixed $value = null): $this

为此事件的数据/有效负载分配一个值。

参数
数组|字符串 $key
混合 $value 可选
返回
$this

setResult() ¶ 公共

setResult(mixed $value = null): $this

监听器可以将结果值附加到事件。

参数
混合 $value 可选

要设置的值。

返回
$this

stopPropagation() ¶ 公共

stopPropagation(): void

停止事件被再次使用

返回
空

属性详细说明

$_data ¶ 受保护的

接收事件的方法的自定义数据

类型
数组

$_name ¶ 受保护的

事件的名称

类型
字符串

$_stopped ¶ 受保护的

标记事件是否停止,默认值为false

类型
布尔值

$_subject ¶ 受保护的

此事件适用的对象(通常是生成事件的相同对象)

类型
对象|null

$result ¶ 受保护的

用于保留事件监听器结果值的属性

使用 setResult() 和 getResult() 设置和获取结果。

类型
混合
OpenHub
Pingping
Linode
  • 商业解决方案
  • 展示
  • 文档
  • 书籍
  • API
  • 视频
  • 报告安全问题
  • 隐私政策
  • 标识 & 商标
  • 社区
  • 参与进来
  • 问题 (Github)
  • 面包房
  • 精选资源
  • 培训
  • 聚会
  • 我的CakePHP
  • CakeFest
  • 时事通讯
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • 帮助 & 支持
  • 论坛
  • Stack Overflow
  • IRC
  • Slack
  • 付费支持

使用 CakePHP API 文档 生成