as2252258/kiri-router
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

qqq

Browse Source
This commit is contained in:
xl
2023-05-26 16:54:27 +08:00
parent 606cf4e154
commit 45af402e9d
2 changed files with 1159 additions and 1139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Constrict/ConstrictRequest.php
+450 -440
View File
@@ -12,480 +12,490 @@ class ConstrictRequest extends Message implements RequestInterface, ServerReques
{ {
/** /**
* @var string * @var string
*/ */
private string $method; private string $method;
/** /**
* @var UriInterface * @var UriInterface
*/ */
private UriInterface $uri; private UriInterface $uri;
/** /**
* @var array|object|null * @var array|object|null
*/ */
private array|null|object $parsedBody = null; private array|null|object $parsedBody = null;
private array $files = []; private array $files = [];
private array $queryParams = []; private array $queryParams = [];
private array $serverParams = []; private array $serverParams = [];
/** /**
* @var AuthorizationInterface|null * @var AuthorizationInterface|null
*/ */
private ?AuthorizationInterface $authorization = null; private ?AuthorizationInterface $authorization = null;
/** /**
* @return AuthorizationInterface|null * @return AuthorizationInterface|null
*/ */
public function getAuthority(): ?AuthorizationInterface public function getAuthority(): ?AuthorizationInterface
{ {
return $this->authorization; return $this->authorization;
} }
/** /**
* @param AuthorizationInterface $authorization * @param AuthorizationInterface $authorization
* @return RequestInterface * @return RequestInterface
*/ */
public function withAuthority(AuthorizationInterface $authorization): RequestInterface public function withAuthority(AuthorizationInterface $authorization): RequestInterface
{ {
$this->authorization = $authorization; $this->authorization = $authorization;
return $this; return $this;
} }
/** /**
* @return bool * @return bool
*/ */
public function getIsPost(): bool public function getIsPost(): bool
{ {
return $this->method === 'POST'; return $this->method === 'POST';
} }
/** /**
* Retrieves the message's request target. * Retrieves the message's request target.
* *
* Retrieves the message's request-target either as it will appear (for * Retrieves the message's request-target either as it will appear (for
* clients), as it appeared at request (for servers), or as it was * clients), as it appeared at request (for servers), or as it was
* specified for the instance (see withRequestTarget()). * specified for the instance (see withRequestTarget()).
* *
* In most cases, this will be the origin-form of the composed URI, * In most cases, this will be the origin-form of the composed URI,
* unless a value was provided to the concrete implementation (see * unless a value was provided to the concrete implementation (see
* withRequestTarget() below). * withRequestTarget() below).
* *
* If no URI is available, and no request-target has been specifically * If no URI is available, and no request-target has been specifically
* provided, this method MUST return the string "/". * provided, this method MUST return the string "/".
* *
* @return string * @return string
*/ */
public function getRequestTarget(): string public function getRequestTarget(): string
{ {
// TODO: Implement getRequestTarget() method. // TODO: Implement getRequestTarget() method.
return (string)$this->getUri(); return (string)$this->getUri();
} }
/** /**
* @param array $headers * @param array $headers
* @return $this * @return $this
*/ */
public function withHeaders(array $headers): static public function withHeaders(array $headers): static
{ {
foreach ($headers as $key => $header) { foreach ($headers as $key => $header) {
$this->withHeader($key, [$header]); $this->withHeader($key, [$header]);
} }
return $this; return $this;
} }
/** /**
* @param string $data * @param string $data
* @return ConstrictRequest * @return ConstrictRequest
*/ */
public function withDataHeaders(string $data): static public function withDataHeaders(string $data): static
{ {
$headers = explode("\r\n\r\n", $data); $headers = explode("\r\n\r\n", $data);
$headers = explode("\r\n", $headers[0]); $headers = explode("\r\n", $headers[0]);
foreach ($headers as $header) { foreach ($headers as $header) {
$keyValue = explode(': ', $header); $keyValue = explode(': ', $header);
if (!isset($keyValue[1])) { if (!isset($keyValue[1])) {
$keyValue[1] = ''; $keyValue[1] = '';
} }
$keyValue[1] = explode(', ', $keyValue[1]); $keyValue[1] = explode(', ', $keyValue[1]);
$this->withHeader(...$keyValue); $this->withHeader(...$keyValue);
} }
return $this; return $this;
} }
/** /**
* Return an instance with the specific request-target. * Return an instance with the specific request-target.
* *
* If the request needs a non-origin-form request-target — e.g., for * If the request needs a non-origin-form request-target — e.g., for
* specifying an absolute-form, authority-form, or asterisk-form — * specifying an absolute-form, authority-form, or asterisk-form —
* this method may be used to create an instance with the specified * this method may be used to create an instance with the specified
* request-target, verbatim. * request-target, verbatim.
* *
* This method MUST be implemented in such a way as to retain the * 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 * immutability of the message, and MUST return an instance that has the
* changed request target. * changed request target.
* *
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various * @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages) * request-target forms allowed in request messages)
* @param string $requestTarget * @param string $requestTarget
* @return static * @return static
*/ */
public function withRequestTarget(string $requestTarget): static public function withRequestTarget(string $requestTarget): static
{ {
// TODO: Implement withRequestTarget() method. // TODO: Implement withRequestTarget() method.
return $this; return $this;
} }
/** /**
* Retrieves the HTTP method of the request. * Retrieves the HTTP method of the request.
* *
* @return string Returns the request method. * @return string Returns the request method.
*/ */
public function getMethod(): string public function getMethod(): string
{ {
// TODO: Implement getMethod() method. // TODO: Implement getMethod() method.
return $this->method; return $this->method;
} }
/** /**
* Return an instance with the provided HTTP method. * Return an instance with the provided HTTP method.
* *
* While HTTP method names are typically all uppercase characters, HTTP * While HTTP method names are typically all uppercase characters, HTTP
* method names are case-sensitive and thus implementations SHOULD NOT * method names are case-sensitive and thus implementations SHOULD NOT
* modify the given string. * modify the given string.
* *
* This method MUST be implemented in such a way as to retain the * 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 * immutability of the message, and MUST return an instance that has the
* changed request method. * changed request method.
* *
* @param string $method Case-sensitive method. * @param string $method Case-sensitive method.
* @return static * @return static
* @throws \InvalidArgumentException for invalid HTTP methods. * @throws \InvalidArgumentException for invalid HTTP methods.
*/ */
public function withMethod(string $method): static public function withMethod(string $method): static
{ {
// TODO: Implement withMethod() method. // TODO: Implement withMethod() method.
$this->method = $method; $this->method = $method;
return $this; return $this;
} }
/** /**
* Retrieves the URI instance. * Retrieves the URI instance.
* *
* This method MUST return a UriInterface instance. * This method MUST return a UriInterface instance.
* *
* @link http://tools.ietf.org/html/rfc3986#section-4.3 * @link http://tools.ietf.org/html/rfc3986#section-4.3
* @return UriInterface Returns a UriInterface instance * @return UriInterface Returns a UriInterface instance
* representing the URI of the request. * representing the URI of the request.
*/ */
public function getUri(): UriInterface public function getUri(): UriInterface
{ {
// TODO: Implement getUri() method. // TODO: Implement getUri() method.
return $this->uri; return $this->uri;
} }
/** /**
* Returns an instance with the provided URI. * Returns an instance with the provided URI.
* *
* This method MUST update the Host header of the returned request by * 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 * 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 * contain a host component, any pre-existing Host header MUST be carried
* over to the returned request. * over to the returned request.
* *
* You can opt-in to preserving the original state of the Host header by * You can opt-in to preserving the original state of the Host header by
* setting `$preserveHost` to `true`. When `$preserveHost` is set to * setting `$preserveHost` to `true`. When `$preserveHost` is set to
* `true`, this method interacts with the Host header in the following ways: * `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 * - 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 * a host component, this method MUST update the Host header in the returned
* request. * request.
* - If the Host header is missing or empty, and the new URI does not contain a * - 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 * host component, this method MUST NOT update the Host header in the returned
* request. * request.
* - If a Host header is present and non-empty, this method MUST NOT update * - If a Host header is present and non-empty, this method MUST NOT update
* the Host header in the returned request. * the Host header in the returned request.
* *
* This method MUST be implemented in such a way as to retain the * 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 * immutability of the message, and MUST return an instance that has the
* new UriInterface instance. * new UriInterface instance.
* *
* @link http://tools.ietf.org/html/rfc3986#section-4.3 * @link http://tools.ietf.org/html/rfc3986#section-4.3
* @param UriInterface $uri New request URI to use. * @param UriInterface $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header. * @param bool $preserveHost Preserve the original state of the Host header.
* @return static * @return static
*/ */
public function withUri(UriInterface $uri, bool $preserveHost = false): static public function withUri(UriInterface $uri, bool $preserveHost = false): static
{ {
// TODO: Implement withUri() method. // TODO: Implement withUri() method.
$this->uri = $uri; $this->uri = $uri;
return $this; return $this;
} }
/** /**
* Retrieve server parameters. * Retrieve server parameters.
* *
* Retrieves data related to the incoming request environment, * Retrieves data related to the incoming request environment,
* typically derived from PHP's $_SERVER superglobal. The data IS NOT * typically derived from PHP's $_SERVER superglobal. The data IS NOT
* REQUIRED to originate from $_SERVER. * REQUIRED to originate from $_SERVER.
* *
* @return array * @return array
*/ */
public function getServerParams(): array public function getServerParams(): array
{ {
// TODO: Implement getServerParams() method. // TODO: Implement getServerParams() method.
return $this->serverParams; return $this->serverParams;
} }
/** /**
* Return an instance with the specified cookies. * @param string $key
* * @return string|int|float|null
* The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST */
* be compatible with the structure of $_COOKIE. Typically, this data will public function getServerParam(string $key): string|int|float|null
* be injected at instantiation. {
* return $this->serverParams[$key] ?? null;
* This method MUST NOT update the related Cookie header of the request }
* instance, nor related values in the server params.
*
* 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
* updated cookie values.
*
* @param array $cookies Array of key/value pairs representing cookies.
* @return static
*/
public function withServerParams(array $cookies): static
{
// TODO: Implement withCookieParams() method.
$this->serverParams = $cookies;
return $this;
}
/**
* Retrieve query string arguments.
*
* Retrieves the deserialized query string arguments, if any.
*
* Note: the query params might not be in sync with the URI or server
* params. If you need to ensure you are only getting the original
* values, you may need to parse the query string from `getUri()->getQuery()`
* or from the `QUERY_STRING` server param.
*
* @return array
*/
public function getQueryParams(): array
{
// TODO: Implement getQueryParams() method.
return $this->queryParams;
}
/** /**
* Return an instance with the specified query string arguments. * Return an instance with the specified cookies.
* *
* These values SHOULD remain immutable over the course of the incoming * The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
* request. They MAY be injected during instantiation, such as from PHP's * be compatible with the structure of $_COOKIE. Typically, this data will
* $_GET superglobal, or MAY be derived from some other value such as the * be injected at instantiation.
* URI. In cases where the arguments are parsed from the URI, the data *
* MUST be compatible with what PHP's parse_str() would return for * This method MUST NOT update the related Cookie header of the request
* purposes of how duplicate query parameters are handled, and how nested * instance, nor related values in the server params.
* sets are handled. *
* * This method MUST be implemented in such a way as to retain the
* Setting query string arguments MUST NOT change the URI stored by the * immutability of the message, and MUST return an instance that has the
* request, nor the values in the server params. * updated cookie values.
* *
* This method MUST be implemented in such a way as to retain the * @param array $cookies Array of key/value pairs representing cookies.
* immutability of the message, and MUST return an instance that has the * @return static
* updated query string arguments. */
* public function withServerParams(array $cookies): static
* @param array $query Array of query string arguments, typically from {
* $_GET. // TODO: Implement withCookieParams() method.
* @return static $this->serverParams = $cookies;
*/ return $this;
public function withQueryParams(array $query): static }
{
// TODO: Implement withQueryParams() method.
$this->queryParams = $query;
return $this;
}
/** /**
* Retrieve normalized file upload data. * Retrieve query string arguments.
* *
* This method returns upload metadata in a normalized tree, with each leaf * Retrieves the deserialized query string arguments, if any.
* an instance of Psr\Http\Message\UploadedFileInterface. *
* * Note: the query params might not be in sync with the URI or server
* These values MAY be prepared from $_FILES or the message body during * params. If you need to ensure you are only getting the original
* instantiation, or MAY be injected via withUploadedFiles(). * values, you may need to parse the query string from `getUri()->getQuery()`
* * or from the `QUERY_STRING` server param.
* @return array An array tree of UploadedFileInterface instances; an empty *
* array MUST be returned if no data is present. * @return array
*/ */
public function getUploadedFiles(): array public function getQueryParams(): array
{ {
// TODO: Implement getUploadedFiles() method. // TODO: Implement getQueryParams() method.
return $this->files; return $this->queryParams;
} }
/** /**
* Create a new instance with the specified uploaded files. * Return an instance with the specified query string arguments.
* *
* This method MUST be implemented in such a way as to retain the * These values SHOULD remain immutable over the course of the incoming
* immutability of the message, and MUST return an instance that has the * request. They MAY be injected during instantiation, such as from PHP's
* updated body parameters. * $_GET superglobal, or MAY be derived from some other value such as the
* * URI. In cases where the arguments are parsed from the URI, the data
* @param array $uploadedFiles An array tree of UploadedFileInterface instances. * MUST be compatible with what PHP's parse_str() would return for
* @return static * purposes of how duplicate query parameters are handled, and how nested
* @throws \InvalidArgumentException if an invalid structure is provided. * sets are handled.
*/ *
public function withUploadedFiles(array $uploadedFiles): static * Setting query string arguments MUST NOT change the URI stored by the
{ * request, nor the values in the server params.
// TODO: Implement withUploadedFiles() method. *
$this->files = $uploadedFiles; * This method MUST be implemented in such a way as to retain the
return $this; * immutability of the message, and MUST return an instance that has the
} * updated query string arguments.
*
* @param array $query Array of query string arguments, typically from
* $_GET.
* @return static
*/
public function withQueryParams(array $query): static
{
// TODO: Implement withQueryParams() method.
$this->queryParams = $query;
return $this;
}
/** /**
* Retrieve any parameters provided in the request body. * Retrieve normalized file upload data.
* *
* If the request Content-Type is either application/x-www-form-urlencoded * This method returns upload metadata in a normalized tree, with each leaf
* or multipart/form-data, and the request method is POST, this method MUST * an instance of Psr\Http\Message\UploadedFileInterface.
* return the contents of $_POST. *
* * These values MAY be prepared from $_FILES or the message body during
* Otherwise, this method may return any results of deserializing * instantiation, or MAY be injected via withUploadedFiles().
* the request body content; as parsing returns structured content, the *
* potential types MUST be arrays or objects only. A null value indicates * @return array An array tree of UploadedFileInterface instances; an empty
* the absence of body content. * array MUST be returned if no data is present.
* */
* @return null|array|object The deserialized body parameters, if any. public function getUploadedFiles(): array
* These will typically be an array or object. {
*/ // TODO: Implement getUploadedFiles() method.
public function getParsedBody(): object|array|null return $this->files;
{ }
// TODO: Implement getParsedBody() method.
return $this->parsedBody;
}
/** /**
* Return an instance with the specified body parameters. * Create a new instance with the specified uploaded files.
* *
* These MAY be injected during instantiation. * 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
* If the request Content-Type is either application/x-www-form-urlencoded * updated body parameters.
* or multipart/form-data, and the request method is POST, use this method *
* ONLY to inject the contents of $_POST. * @param array $uploadedFiles An array tree of UploadedFileInterface instances.
* * @return static
* The data IS NOT REQUIRED to come from $_POST, but MUST be the results of * @throws \InvalidArgumentException if an invalid structure is provided.
* deserializing the request body content. Deserialization/parsing returns */
* structured data, and, as such, this method ONLY accepts arrays or objects, public function withUploadedFiles(array $uploadedFiles): static
* or a null value if nothing was available to parse. {
* // TODO: Implement withUploadedFiles() method.
* As an example, if content negotiation determines that the request data $this->files = $uploadedFiles;
* is a JSON payload, this method could be used to create a request return $this;
* instance with the deserialized parameters. }
*
* 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
* updated body parameters.
*
* @param null|array|object $data The deserialized body data. This will
* typically be in an array or object.
* @return static
* @throws \InvalidArgumentException if an unsupported argument type is
* provided.
*/
public function withParsedBody($data): static
{
// TODO: Implement withParsedBody() method.
$this->parsedBody = $data;
return $this;
}
/** /**
* Retrieve attributes derived from the request. * Retrieve any parameters provided in the request body.
* *
* The request "attributes" may be used to allow injection of any * If the request Content-Type is either application/x-www-form-urlencoded
* parameters derived from the request: e.g., the results of path * or multipart/form-data, and the request method is POST, this method MUST
* match operations; the results of decrypting cookies; the results of * return the contents of $_POST.
* deserializing non-form-encoded message bodies; etc. Attributes *
* will be application and request specific, and CAN be mutable. * Otherwise, this method may return any results of deserializing
* * the request body content; as parsing returns structured content, the
* @return array Attributes derived from the request. * potential types MUST be arrays or objects only. A null value indicates
*/ * the absence of body content.
public function getAttributes(): array *
{ * @return null|array|object The deserialized body parameters, if any.
// TODO: Implement getAttributes() method. * These will typically be an array or object.
return []; */
} public function getParsedBody(): object|array|null
{
// TODO: Implement getParsedBody() method.
return $this->parsedBody;
}
/** /**
* Retrieve a single derived request attribute. * Return an instance with the specified body parameters.
* *
* Retrieves a single derived request attribute as described in * These MAY be injected during instantiation.
* getAttributes(). If the attribute has not been previously set, returns *
* the default value as provided. * If the request Content-Type is either application/x-www-form-urlencoded
* * or multipart/form-data, and the request method is POST, use this method
* This method obviates the need for a hasAttribute() method, as it allows * ONLY to inject the contents of $_POST.
* specifying a default value to return if the attribute is not found. *
* * The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
* @param string $name The attribute name. * deserializing the request body content. Deserialization/parsing returns
* @param mixed $default Default value to return if the attribute does not exist. * structured data, and, as such, this method ONLY accepts arrays or objects,
* @return mixed * or a null value if nothing was available to parse.
* @see getAttributes() *
*/ * As an example, if content negotiation determines that the request data
public function getAttribute(string $name, $default = null): mixed * is a JSON payload, this method could be used to create a request
{ * instance with the deserialized parameters.
// TODO: Implement getAttribute() method. *
return null; * 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
* updated body parameters.
*
* @param null|array|object $data The deserialized body data. This will
* typically be in an array or object.
* @return static
* @throws \InvalidArgumentException if an unsupported argument type is
* provided.
*/
public function withParsedBody($data): static
{
// TODO: Implement withParsedBody() method.
$this->parsedBody = $data;
return $this;
}
/** /**
* Return an instance with the specified derived request attribute. * Retrieve attributes derived from the request.
* *
* This method allows setting a single derived request attribute as * The request "attributes" may be used to allow injection of any
* described in getAttributes(). * parameters derived from the request: e.g., the results of path
* * match operations; the results of decrypting cookies; the results of
* This method MUST be implemented in such a way as to retain the * deserializing non-form-encoded message bodies; etc. Attributes
* immutability of the message, and MUST return an instance that has the * will be application and request specific, and CAN be mutable.
* updated attribute. *
* * @return array Attributes derived from the request.
* @param string $name The attribute name. */
* @param mixed $value The value of the attribute. public function getAttributes(): array
* @return static {
* @see getAttributes() // TODO: Implement getAttributes() method.
*/ return [];
public function withAttribute(string $name, $value): static }
{
// TODO: Implement withAttribute() method.
return $this;
}
/** /**
* Return an instance that removes the specified derived request attribute. * Retrieve a single derived request attribute.
* *
* This method allows removing a single derived request attribute as * Retrieves a single derived request attribute as described in
* described in getAttributes(). * getAttributes(). If the attribute has not been previously set, returns
* * the default value as provided.
* This method MUST be implemented in such a way as to retain the *
* immutability of the message, and MUST return an instance that removes * This method obviates the need for a hasAttribute() method, as it allows
* the attribute. * specifying a default value to return if the attribute is not found.
* *
* @param string $name The attribute name. * @param string $name The attribute name.
* @return static * @param mixed $default Default value to return if the attribute does not exist.
* @see getAttributes() * @return mixed
*/ * @see getAttributes()
public function withoutAttribute(string $name): static */
{ public function getAttribute(string $name, $default = null): mixed
// TODO: Implement withoutAttribute() method. {
return $this; // TODO: Implement getAttribute() method.
} return null;
}
/**
* Return an instance with the specified derived request attribute.
*
* This method allows setting a single derived request attribute as
* described in getAttributes().
*
* 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
* updated attribute.
*
* @param string $name The attribute name.
* @param mixed $value The value of the attribute.
* @return static
* @see getAttributes()
*/
public function withAttribute(string $name, $value): static
{
// TODO: Implement withAttribute() method.
return $this;
}
/**
* Return an instance that removes the specified derived request attribute.
*
* This method allows removing a single derived request attribute as
* described in getAttributes().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that removes
* the attribute.
*
* @param string $name The attribute name.
* @return static
* @see getAttributes()
*/
public function withoutAttribute(string $name): static
{
// TODO: Implement withoutAttribute() method.
return $this;
}
} }
src/Request.php
+709 -699
View File
File diff suppressed because it is too large Load Diff