-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Expand file tree
/
Copy pathClientEvent.php
More file actions
120 lines (107 loc) · 2.96 KB
/
Copy pathClientEvent.php
File metadata and controls
120 lines (107 loc) · 2.96 KB
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
<?php
declare(strict_types=1);
/**
* 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 5.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Client;
use Cake\Event\Event;
use Cake\Http\Client;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
/**
* Class Client Event
*
* @extends \Cake\Event\Event<\Cake\Http\Client>
*/
class ClientEvent extends Event
{
/**
* Constructor
*
* @param string $name Name of the event
* @param \Cake\Http\Client $subject The Http Client instance this event applies to.
* @param array $data Any value you wish to be transported
* with this event to it can be read by listeners.
*/
public function __construct(string $name, Client $subject, array $data = [])
{
if (isset($data['response'])) {
$this->result = $data['response'];
unset($data['response']);
}
parent::__construct($name, $subject, $data);
}
/**
* The result value of the event listeners
*
* @return \Cake\Http\Client\Response|null
*/
public function getResult(): ?Response
{
return $this->result;
}
/**
* Listeners can attach a result value to the event.
*
* @param mixed $value The value to set.
* @return $this
*/
public function setResult(mixed $value = null)
{
if ($value !== null && !$value instanceof Response) {
throw new InvalidArgumentException(
'The result for Http Client events must be a `Cake\Http\Client\Response` instance.',
);
}
return parent::setResult($value);
}
/**
* Set request instance.
*
* @param \Psr\Http\Message\RequestInterface $request
* @return $this
*/
public function setRequest(RequestInterface $request)
{
$this->_data['request'] = $request;
return $this;
}
/**
* Get the request instance.
*
* @return \Psr\Http\Message\RequestInterface
*/
public function getRequest(): RequestInterface
{
return $this->_data['request'];
}
/**
* Set the adapter options.
*
* @return $this
*/
public function setAdapterOptions(array $options = [])
{
$this->_data['adapterOptions'] = $options;
return $this;
}
/**
* Get the adapter options.
*
* @return array
*/
public function getAdapterOptions(): array
{
return $this->_data['adapterOptions'];
}
}