-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequest.php
More file actions
265 lines (250 loc) · 8.43 KB
/
Copy pathRequest.php
File metadata and controls
265 lines (250 loc) · 8.43 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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<?php
/**
* This file is part of HttpMessage
*
* @package bdk/http-message
* @author Brad Kent <bkfake-github@yahoo.com>
* @license http://opensource.org/licenses/MIT MIT
* @copyright 2014-2024 Brad Kent
* @version v1.0
*/
namespace bdk\HttpMessage;
use bdk\HttpMessage\Message;
use bdk\HttpMessage\Uri;
use InvalidArgumentException;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\UriInterface;
/**
* Http Request
*
* @psalm-consistent-constructor
*/
class Request extends Message implements RequestInterface
{
/** @var string */
private $method = 'GET';
/** @var string|null */
private $requestTarget;
/** @var UriInterface */
private $uri;
/**
* Constructor
*
* @param string $method The HTTP method associated with the request.
* @param UriInterface|string $uri The URI associated with the request.
*
* @throws InvalidArgumentException
*/
public function __construct($method = 'GET', $uri = '')
{
$this->assertMethod($method);
$this->method = \strtoupper($method);
if (\is_string($uri) || $uri === null) {
$uri = new Uri($uri);
} elseif (!($uri instanceof UriInterface)) {
throw new InvalidArgumentException('uri must be a string or instance of UriInterface');
}
$this->uri = $uri;
// set host header if we have a hostname
$new = $this->updateHostHeader();
$headers = $new->getHeaders();
$this->setHeaders($headers);
}
/**
* Retrieves the message's request target.
*
* Retrieves the message's request-target either as it will appear (for
* clients), as it appeared at request (for servers), or as it was
* specified for the instance (see withRequestTarget()).
*
* In most cases, this will be the origin-form of the composed URI,
* unless a value was provided to the concrete implementation (see
* withRequestTarget() below).
*
* If no URI is available, and no request-target has been specifically
* provided, this method MUST return the string "/".
*
* @return string
*/
public function getRequestTarget(): string
{
if ($this->requestTarget !== null) {
return $this->requestTarget;
}
$target = $this->uri->getPath();
if ($target === '') {
$target = '/';
}
$query = $this->uri->getQuery();
if ($query !== '') {
$target .= '?' . $query;
}
return $target;
}
/**
* Return an instance with the specific request-target.
*
* If the request needs a non-origin-form request-target — e.g., for
* specifying an absolute-form, authority-form, or asterisk-form —
* this method may be used to create an instance with the specified
* request-target, verbatim.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* changed request target.
*
* @param string $requestTarget new request target
*
* @see https://datatracker.ietf.org/doc/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages)
*
* @return static
* @throws InvalidArgumentException
*/
public function withRequestTarget(string $requestTarget): static
{
if (\is_string($requestTarget) === false) {
throw new InvalidArgumentException(
'Request target must be a string.'
);
}
if (\preg_match('#\s#', $requestTarget)) {
throw new InvalidArgumentException(
'Request target cannot contain whitespace'
);
}
$new = clone $this;
$new->requestTarget = $requestTarget;
return $new;
}
/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
*/
public function getMethod(): string
{
return $this->method;
}
/**
* Return an instance with the provided HTTP method.
*
* Standard methods include:
* HEAD: Asks for a response identical to that of a GET request,
* but without the response body.
* GET: Requests a representation of the specified resource
* Requests using GET should only retrieve data.
* POST: Submit an entity to the specified resource,
* Often causing a change in state or side effects on the server.
* PUT: Replaces all current representations of the target resource with the request payload.
* DELETE: Deletes the specified resource.
* PATCH: Used to apply partial modifications to a resource.
* CONNECT: Establishes a tunnel to the server identified by the target resource.
* OPTIONS: Used to describe the communication options for the target resource.
* TRACE: Performs a message loop-back test along the path to the target resource.
*
* @param string $method Case-sensitive method.
*
* @return static
* @throws InvalidArgumentException for invalid HTTP methods.
*
* @see https://datatracker.ietf.org/doc/html/rfc7231
*/
public function withMethod(string $method): static
{
$this->assertMethod($method);
$new = clone $this;
$new->method = $method;
return $new;
}
/**
* Retrieves the URI instance.
*
* This method MUST return a UriInterface instance.
*
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request.
*
* @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.3
*/
public function getUri(): UriInterface
{
return $this->uri;
}
/**
* Returns an instance with the provided URI.
*
* This method MUST update the Host header of the returned request by
* default if the URI contains a host component. If the URI does not
* contain a host component, any pre-existing Host header MUST be carried
* over to the returned request.
*
* You can opt-in to preserving the original state of the Host header by
* setting `$preserveHost` to `true`. When `$preserveHost` is set to
* `true`, this method interacts with the Host header in the following ways:
*
* - If the Host header is missing or empty, and the new URI contains
* a host component, this method MUST update the Host header in the returned
* request.
* - If the Host header is missing or empty, and the new URI does not contain a
* host component, this method MUST NOT update the Host header in the returned
* request.
* - If a Host header is present and non-empty, this method MUST NOT update
* the Host header in the returned request.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new UriInterface instance.
*
* @param UriInterface $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header.
*
* @see https://datatracker.ietf.org/doc/html/rfc3986#section-4.3
*
* @return static
*
* @throws InvalidArgumentException
*/
public function withUri(UriInterface $uri, bool $preserveHost = false): static
{
if ($uri === $this->uri) {
return $this;
}
$new = clone $this;
$new->uri = $uri;
return $preserveHost && $this->hasHeader('Host')
? $new
: $new->updateHostHeader();
}
/**
* {@inheritDoc}
*/
#[\Override]
public function withoutHeader(string $name): static
{
$new = parent::withoutHeader($name);
return \strtolower($name) === 'host'
? $new->updateHostHeader()
: $new;
}
/**
* if uri has non-empty host
* then Return the new Request with updated header
* otherwise return static
*
* @return static
*/
private function updateHostHeader(): static
{
$uri = $this->getUri();
$host = $uri->getHost();
if ($host === '') {
return $this;
}
$port = $uri->getPort();
if ($port !== null) {
$host .= ':' . $port;
}
return $this->withHeader('Host', $host);
}
}