777 lines
26 KiB
PHP
777 lines
26 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
namespace Kiri\Router;
|
|
|
|
use Kiri\Di\Context;
|
|
use Kiri\Router\Base\AuthorizationInterface;
|
|
use Kiri\Router\Base\ExceptionHandlerDispatcher;
|
|
use Psr\Http\Message\RequestInterface;
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use Psr\Http\Message\StreamInterface;
|
|
use Psr\Http\Message\UriInterface;
|
|
|
|
|
|
/**
|
|
* @property-read bool $isPost
|
|
* @property-read AuthorizationInterface $authority
|
|
*/
|
|
class Request implements ServerRequestInterface
|
|
{
|
|
|
|
|
|
public array $middlewares = [];
|
|
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
public string $exception = ExceptionHandlerDispatcher::class;
|
|
|
|
|
|
/**
|
|
* 初始化
|
|
*/
|
|
public function __construct()
|
|
{
|
|
$this->middlewares = \config('request.middlewares', []);
|
|
$this->exception = \config('request.exception', ExceptionHandlerDispatcher::class);
|
|
}
|
|
|
|
|
|
/**
|
|
* @return AuthorizationInterface|null
|
|
*/
|
|
public function getAuthority(): ?AuthorizationInterface
|
|
{
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param AuthorizationInterface $authorization
|
|
* @return RequestInterface
|
|
*/
|
|
public function withAuthority(AuthorizationInterface $authorization): RequestInterface
|
|
{
|
|
return $this->__call__(__FUNCTION__, $authorization);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $method
|
|
* @param mixed ...$params
|
|
* @return mixed
|
|
*/
|
|
private function __call__(string $method, ...$params): mixed
|
|
{
|
|
if (!Context::exists(RequestInterface::class)) {
|
|
$response = Context::set(RequestInterface::class, new static());
|
|
} else {
|
|
$response = Context::get(RequestInterface::class);
|
|
}
|
|
return $response->{$method}(...$params);
|
|
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $name
|
|
* @return mixed
|
|
*/
|
|
public function __get(string $name): mixed
|
|
{
|
|
// TODO: Implement __get() method.
|
|
return $this->__call__('get' . ucfirst($name));
|
|
}
|
|
|
|
|
|
/**
|
|
* Retrieves the HTTP protocol version as a string.
|
|
*
|
|
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
|
|
*
|
|
* @return string HTTP protocol version.
|
|
*/
|
|
public function getProtocolVersion(): string
|
|
{
|
|
// TODO: Implement getProtocolVersion() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $key
|
|
* @return string|int|float|null
|
|
*/
|
|
public function getServerParam(string $key): string|int|float|null
|
|
{
|
|
return $this->__call__(__FUNCTION__)($key);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the specified HTTP protocol version.
|
|
*
|
|
* The version string MUST contain only the HTTP version number (e.g.,
|
|
* "1.1", "1.0").
|
|
*
|
|
* 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 protocol version.
|
|
*
|
|
* @param string $version HTTP protocol version
|
|
* @return static
|
|
*/
|
|
public function withProtocolVersion(string $version): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withProtocolVersion() method.
|
|
return $this->__call__(__FUNCTION__, $version);
|
|
}
|
|
|
|
/**
|
|
* Retrieves all message header values.
|
|
*
|
|
* The keys represent the header name as it will be sent over the wire, and
|
|
* each value is an array of strings associated with the header.
|
|
*
|
|
* // Represent the headers as a string
|
|
* foreach ($message->getHeaders() as $name => $values) {
|
|
* echo $name . ": " . implode(", ", $values);
|
|
* }
|
|
*
|
|
* // Emit headers iteratively:
|
|
* foreach ($message->getHeaders() as $name => $values) {
|
|
* foreach ($values as $value) {
|
|
* header(sprintf('%s: %s', $name, $value), false);
|
|
* }
|
|
* }
|
|
*
|
|
* While header names are not case-sensitive, getHeaders() will preserve the
|
|
* exact case in which headers were originally specified.
|
|
*
|
|
* @return string[][] Returns an associative array of the message's headers. Each
|
|
* key MUST be a header name, and each value MUST be an array of strings
|
|
* for that header.
|
|
*/
|
|
public function getHeaders(): array
|
|
{
|
|
// TODO: Implement getHeaders() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Checks if a header exists by the given case-insensitive name.
|
|
*
|
|
* @param string $name Case-insensitive header field name.
|
|
* @return bool Returns true if any header names match the given header
|
|
* name using a case-insensitive string comparison. Returns false if
|
|
* no matching header name is found in the message.
|
|
*/
|
|
public function hasHeader(string $name): bool
|
|
{
|
|
// TODO: Implement hasHeader() method.
|
|
return $this->__call__(__FUNCTION__, $name);
|
|
}
|
|
|
|
/**
|
|
* Retrieves a message header value by the given case-insensitive name.
|
|
*
|
|
* This method returns an array of all the header values of the given
|
|
* case-insensitive header name.
|
|
*
|
|
* If the header does not appear in the message, this method MUST return an
|
|
* empty array.
|
|
*
|
|
* @param string $name Case-insensitive header field name.
|
|
* @return string[] An array of string values as provided for the given
|
|
* header. If the header does not appear in the message, this method MUST
|
|
* return an empty array.
|
|
*/
|
|
public function getHeader(string $name): array
|
|
{
|
|
// TODO: Implement getHeader() method.
|
|
return $this->__call__(__FUNCTION__, $name);
|
|
}
|
|
|
|
/**
|
|
* Retrieves a comma-separated string of the values for a single header.
|
|
*
|
|
* This method returns all of the header values of the given
|
|
* case-insensitive header name as a string concatenated together using
|
|
* a comma.
|
|
*
|
|
* NOTE: Not all header values may be appropriately represented using
|
|
* comma concatenation. For such headers, use getHeader() instead
|
|
* and supply your own delimiter when concatenating.
|
|
*
|
|
* If the header does not appear in the message, this method MUST return
|
|
* an empty string.
|
|
*
|
|
* @param string $name Case-insensitive header field name.
|
|
* @return string A string of values as provided for the given header
|
|
* concatenated together using a comma. If the header does not appear in
|
|
* the message, this method MUST return an empty string.
|
|
*/
|
|
public function getHeaderLine(string $name): string
|
|
{
|
|
// TODO: Implement getHeaderLine() method.
|
|
return $this->__call__(__FUNCTION__, $name);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the provided value replacing the specified header.
|
|
*
|
|
* While header names are case-insensitive, the casing of the header will
|
|
* be preserved by this function, and returned from getHeaders().
|
|
*
|
|
* 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 and/or updated header and value.
|
|
*
|
|
* @param string $name Case-insensitive header field name.
|
|
* @param string|string[] $value Header value(s).
|
|
* @return static
|
|
* @throws \InvalidArgumentException for invalid header names or values.
|
|
*/
|
|
public function withHeader(string $name, $value): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withHeader() method.
|
|
return $this->__call__(__FUNCTION__, $name, $value);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $data
|
|
* @return ServerRequestInterface
|
|
*/
|
|
public function withDataHeaders(string $data): ServerRequestInterface
|
|
{
|
|
return $this->__call__(__FUNCTION__, $data);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param array $headers
|
|
* @return ServerRequestInterface
|
|
*/
|
|
public function withHeaders(array $headers): ServerRequestInterface
|
|
{
|
|
return $this->__call__(__FUNCTION__, $headers);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param string|null $default
|
|
* @return string|null
|
|
*/
|
|
public function header(string $name, ?string $default = null): ?string
|
|
{
|
|
return $this->__call__(__FUNCTION__, $name, $default);
|
|
}
|
|
|
|
|
|
/**
|
|
* Return an instance with the specified header appended with the given value.
|
|
*
|
|
* Existing values for the specified header will be maintained. The new
|
|
* value(s) will be appended to the existing list. If the header did not
|
|
* exist previously, it will be added.
|
|
*
|
|
* 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 header and/or value.
|
|
*
|
|
* @param string $name Case-insensitive header field name to add.
|
|
* @param string|string[] $value Header value(s).
|
|
* @return static
|
|
* @throws \InvalidArgumentException for invalid header names or values.
|
|
*/
|
|
public function withAddedHeader(string $name, $value): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withAddedHeader() method.
|
|
return $this->__call__(__FUNCTION__, $name, $value);
|
|
}
|
|
|
|
/**
|
|
* Return an instance without the specified header.
|
|
*
|
|
* Header resolution MUST be done without case-sensitivity.
|
|
*
|
|
* 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 named header.
|
|
*
|
|
* @param string $name Case-insensitive header field name to remove.
|
|
* @return static
|
|
*/
|
|
public function withoutHeader(string $name): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withoutHeader() method.
|
|
return $this->__call__(__FUNCTION__, $name);
|
|
}
|
|
|
|
/**
|
|
* Gets the body of the message.
|
|
*
|
|
* @return StreamInterface Returns the body as a stream.
|
|
*/
|
|
public function getBody(): StreamInterface
|
|
{
|
|
// TODO: Implement getBody() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the specified message body.
|
|
*
|
|
* The body MUST be a StreamInterface object.
|
|
*
|
|
* This method MUST be implemented in such a way as to retain the
|
|
* immutability of the message, and MUST return a new instance that has the
|
|
* new body stream.
|
|
*
|
|
* @param StreamInterface $body Body.
|
|
* @return static
|
|
* @throws \InvalidArgumentException When the body is not valid.
|
|
*/
|
|
public function withBody(StreamInterface $body): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withBody() method.
|
|
return $this->__call__(__FUNCTION__, $body);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
{
|
|
// TODO: Implement getRequestTarget() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
|
|
* request-target forms allowed in request messages)
|
|
* @param string $requestTarget
|
|
* @return static
|
|
*/
|
|
public function withRequestTarget(string $requestTarget): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withRequestTarget() method.
|
|
return $this->__call__(__FUNCTION__, $requestTarget);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the HTTP method of the request.
|
|
*
|
|
* @return string Returns the request method.
|
|
*/
|
|
public function getMethod(): string
|
|
{
|
|
// TODO: Implement getMethod() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the provided HTTP method.
|
|
*
|
|
* While HTTP method names are typically all uppercase characters, HTTP
|
|
* method names are case-sensitive and thus implementations SHOULD NOT
|
|
* modify the given string.
|
|
*
|
|
* 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 method.
|
|
*
|
|
* @param string $method Case-sensitive method.
|
|
* @return static
|
|
* @throws \InvalidArgumentException for invalid HTTP methods.
|
|
*/
|
|
public function withMethod(string $method): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withMethod() method.
|
|
return $this->__call__(__FUNCTION__, $method);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the URI instance.
|
|
*
|
|
* This method MUST return a UriInterface instance.
|
|
*
|
|
* @link http://tools.ietf.org/html/rfc3986#section-4.3
|
|
* @return UriInterface Returns a UriInterface instance
|
|
* representing the URI of the request.
|
|
*/
|
|
public function getUri(): UriInterface
|
|
{
|
|
// TODO: Implement getUri() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @link http://tools.ietf.org/html/rfc3986#section-4.3
|
|
* @param UriInterface $uri New request URI to use.
|
|
* @param bool $preserveHost Preserve the original state of the Host header.
|
|
* @return static
|
|
*/
|
|
public function withUri(UriInterface $uri, bool $preserveHost = false): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withUri() method.
|
|
return $this->__call__(__FUNCTION__, $uri, $preserveHost);
|
|
}
|
|
|
|
/**
|
|
* Retrieve server parameters.
|
|
*
|
|
* Retrieves data related to the incoming request environment,
|
|
* typically derived from PHP's $_SERVER superglobal. The data IS NOT
|
|
* REQUIRED to originate from $_SERVER.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getServerParams(): array
|
|
{
|
|
// TODO: Implement getServerParams() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Retrieve cookies.
|
|
*
|
|
* Retrieves cookies sent by the client to the server.
|
|
*
|
|
* The data MUST be compatible with the structure of the $_COOKIE
|
|
* superglobal.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getCookieParams(): array
|
|
{
|
|
// TODO: Implement getCookieParams() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the specified cookies.
|
|
*
|
|
* The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
|
|
* be compatible with the structure of $_COOKIE. Typically, this data will
|
|
* be injected at instantiation.
|
|
*
|
|
* 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 withCookieParams(array $cookies): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withCookieParams() method.
|
|
return $this->__call__(__FUNCTION__, $cookies);
|
|
}
|
|
|
|
/**
|
|
* 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->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Return an instance with the specified query string arguments.
|
|
*
|
|
* These values SHOULD remain immutable over the course of the incoming
|
|
* request. They MAY be injected during instantiation, such as from PHP's
|
|
* $_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
|
|
* MUST be compatible with what PHP's parse_str() would return for
|
|
* purposes of how duplicate query parameters are handled, and how nested
|
|
* sets are handled.
|
|
*
|
|
* Setting query string arguments MUST NOT change the URI stored by the
|
|
* request, nor the 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 query string arguments.
|
|
*
|
|
* @param array $query Array of query string arguments, typically from
|
|
* $_GET.
|
|
* @return static
|
|
*/
|
|
public function withQueryParams(array $query): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withQueryParams() method.
|
|
return $this->__call__(__FUNCTION__, $query);
|
|
}
|
|
|
|
/**
|
|
* Retrieve normalized file upload data.
|
|
*
|
|
* This method returns upload metadata in a normalized tree, with each leaf
|
|
* an instance of Psr\Http\Message\UploadedFileInterface.
|
|
*
|
|
* These values MAY be prepared from $_FILES or the message body during
|
|
* instantiation, or MAY be injected via withUploadedFiles().
|
|
*
|
|
* @return array An array tree of UploadedFileInterface instances; an empty
|
|
* array MUST be returned if no data is present.
|
|
*/
|
|
public function getUploadedFiles(): array
|
|
{
|
|
// TODO: Implement getUploadedFiles() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Create a new instance with the specified uploaded files.
|
|
*
|
|
* 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 array $uploadedFiles An array tree of UploadedFileInterface instances.
|
|
* @return static
|
|
* @throws \InvalidArgumentException if an invalid structure is provided.
|
|
*/
|
|
public function withUploadedFiles(array $uploadedFiles): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withUploadedFiles() method.
|
|
return $this->__call__(__FUNCTION__, $uploadedFiles);
|
|
}
|
|
|
|
/**
|
|
* Retrieve any parameters provided in the request body.
|
|
*
|
|
* If the request Content-Type is either application/x-www-form-urlencoded
|
|
* or multipart/form-data, and the request method is POST, this method MUST
|
|
* return the contents of $_POST.
|
|
*
|
|
* Otherwise, this method may return any results of deserializing
|
|
* the request body content; as parsing returns structured content, the
|
|
* potential types MUST be arrays or objects only. A null value indicates
|
|
* the absence of body content.
|
|
*
|
|
* @return null|array|object The deserialized body parameters, if any.
|
|
* These will typically be an array or object.
|
|
*/
|
|
public function getParsedBody(): object|array|null
|
|
{
|
|
// TODO: Implement getParsedBody() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed|null $default
|
|
* @return mixed
|
|
*/
|
|
public function post(string $name, mixed $default = null): mixed
|
|
{
|
|
$parseBody = $this->getParsedBody();
|
|
if ($parseBody instanceof \Closure) {
|
|
$this->withParsedBody($parseBody = call_user_func($parseBody));
|
|
}
|
|
return $parseBody[$name] ?? $default;
|
|
}
|
|
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getIsPost(): bool
|
|
{
|
|
return $this->getMethod() == 'POST';
|
|
}
|
|
|
|
|
|
/**
|
|
* @param string $name
|
|
* @param mixed $default
|
|
* @return mixed
|
|
*/
|
|
public function query(string $name, mixed $default = null): mixed
|
|
{
|
|
return $this->getQueryParams()[$name] ?? $default;
|
|
}
|
|
|
|
|
|
/**
|
|
* Return an instance with the specified body parameters.
|
|
*
|
|
* These MAY be injected during instantiation.
|
|
*
|
|
* 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
|
|
* ONLY to inject the contents of $_POST.
|
|
*
|
|
* The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
|
|
* deserializing the request body content. Deserialization/parsing returns
|
|
* structured data, and, as such, this method ONLY accepts arrays or objects,
|
|
* or a null value if nothing was available to parse.
|
|
*
|
|
* As an example, if content negotiation determines that the request data
|
|
* is a JSON payload, this method could be used to create a request
|
|
* 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): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withParsedBody() method.
|
|
return $this->__call__(__FUNCTION__, $data);
|
|
}
|
|
|
|
/**
|
|
* Retrieve attributes derived from the request.
|
|
*
|
|
* The request "attributes" may be used to allow injection of any
|
|
* parameters derived from the request: e.g., the results of path
|
|
* match operations; the results of decrypting cookies; the results of
|
|
* deserializing non-form-encoded message bodies; etc. Attributes
|
|
* will be application and request specific, and CAN be mutable.
|
|
*
|
|
* @return array Attributes derived from the request.
|
|
*/
|
|
public function getAttributes(): array
|
|
{
|
|
// TODO: Implement getAttributes() method.
|
|
return $this->__call__(__FUNCTION__);
|
|
}
|
|
|
|
/**
|
|
* Retrieve a single derived request attribute.
|
|
*
|
|
* Retrieves a single derived request attribute as described in
|
|
* getAttributes(). If the attribute has not been previously set, returns
|
|
* the default value as provided.
|
|
*
|
|
* This method obviates the need for a hasAttribute() method, as it allows
|
|
* specifying a default value to return if the attribute is not found.
|
|
*
|
|
* @param string $name The attribute name.
|
|
* @param mixed $default Default value to return if the attribute does not exist.
|
|
* @return mixed
|
|
* @see getAttributes()
|
|
*/
|
|
public function getAttribute(string $name, $default = null): mixed
|
|
{
|
|
// TODO: Implement getAttribute() method.
|
|
return $this->__call__(__FUNCTION__, $name, $default);
|
|
}
|
|
|
|
/**
|
|
* 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): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withAttribute() method.
|
|
return $this->__call__(__FUNCTION__, $name, $value);
|
|
}
|
|
|
|
/**
|
|
* 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): ServerRequestInterface
|
|
{
|
|
// TODO: Implement withoutAttribute() method.
|
|
return $this->__call__(__FUNCTION__, $name);
|
|
}
|
|
}
|