类 ClientEvent
类 客户端 事件
命名空间: Cake\Http\Client
属性摘要
方法摘要
-
__construct() public
构造函数
-
getAdapterOptions() public
获取适配器选项。
-
getData() public
访问事件数据/有效负载。
-
getName() public
返回此事件的名称。这通常用作事件标识符
-
getRequest() public
获取请求实例。
-
getResult() public
事件监听器的结果值
-
getSubject() public
返回此事件的主题
-
isStopped() public
检查事件是否已停止
-
setAdapterOptions() public
设置适配器选项。
-
setData() public
为此事件的数据/有效负载分配一个值。
-
setRequest() public
设置请求实例。
-
setResult() public
监听器可以将结果值附加到事件。
-
stopPropagation() public
阻止事件被进一步使用
方法详细信息
__construct() ¶ public
__construct(string $name, Cake\Http\Client $subject, array $data = [])构造函数
用法示例
$event = new Event('Order.afterBuy', $this, ['buyer' => $userData]);
$event = new Event('User.afterRegister', $userModel);参数
-
string$name 事件名称
-
Cake\Http\Client$subject 此事件适用的 HTTP 客户端实例。
-
array$data optional 您希望使用此事件传输的任何值，监听器可以读取。
getData() ¶ public
getData(string|null $key = null): mixed访问事件数据/有效负载。
参数
-
string|null$key optional
返回值
混合getRequest() ¶ public
getRequest(): Psr\Http\Message\RequestInterface获取请求实例。
返回值
Psr\Http\Message\RequestInterfacegetResult() ¶ public
getResult(): Cake\Http\Client\Response|null事件监听器的结果值
返回值
Cake\Http\Client\Response|nullgetSubject() ¶ public
getSubject(): object返回此事件的主题
如果事件没有主题，则会引发异常。
返回值
对象抛出
Cake\Core\Exception\CakeExceptionsetAdapterOptions() ¶ public
setAdapterOptions(array $options = []): $this设置适配器选项。
参数
-
array$options optional
返回值
$thissetData() ¶ public
setData(array|string $key, mixed $value = null): $this为此事件的数据/有效负载分配一个值。
参数
-
array|string$key -
mixed$value optional
返回值
$thissetRequest() ¶ public
setRequest(Psr\Http\Message\RequestInterface $request): $this设置请求实例。
参数
-
Psr\Http\Message\RequestInterface$request
返回值
$thissetResult() ¶ public
setResult(mixed $value = null): $this监听器可以将结果值附加到事件。
参数
-
mixed$value optional 要设置的值。
返回值
$this