Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
@localzet
localzet committed Jul 25, 2023
1 parent 219bcdf commit 6737e08
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 228 deletions.
171 changes: 28 additions & 143 deletions src/Http/Message/MessageInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

namespace localzet\PSR\Http\Message;

use InvalidArgumentException;

/**
* HTTP messages consist of requests from a client to a server and responses
* from a server to a client. This interface defines the methods common to
Expand All @@ -21,171 +19,58 @@
interface MessageInterface
{
/**
* Retrieves the HTTP protocol version as a string.
*
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
* Get query.
*
* @return string HTTP protocol version.
* @param string|null $name
* @param mixed|null $default
* @return mixed
*/
public function getProtocolVersion(): string;
public function get(string $name = null, mixed $default = null): mixed;

/**
* 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").
* Get post.
*
* 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
* @param string|null $name
* @param mixed|null $default
* @return mixed
*/
public function withProtocolVersion(string $version): MessageInterface;
public function post(string $name = null, mixed $default = null): mixed;

/**
* 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.
* Get header item by name.
*
* // 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.
* @param string|null $name
* @param mixed|null $default
* @return mixed
*/
public function getHeaders(): array;
public function header(string $name = null, mixed $default = null): mixed;

/**
* Checks if a header exists by the given case-insensitive name.
* Get http raw head.
*
* @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.
* @return string
*/
public function hasHeader(string $name): bool;
public function rawHead(): string;

/**
* 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.
* Get http raw body.
*
* @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.
* @return string
*/
public function getHeader(string $name): array;
public function rawBody(): string;

/**
* 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;

/**
* 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.
* Get upload files.
*
* @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.
* @param string|null $name
* @return array|null
*/
public function withHeader(string $name, array|string $value): MessageInterface;
public function file(string $name = null): ?array;

/**
* 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, array|string $value): MessageInterface;

/**
* 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): MessageInterface;

/**
* Gets the body of the message.
*
* @return StreamInterface Returns the body as a stream.
*/
public function getBody(): StreamInterface;

/**
* 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.
* Get raw buffer.
*
* @param StreamInterface $body Body.
* @return static
* @throws InvalidArgumentException When the body is not valid.
* @return string
*/
public function withBody(StreamInterface $body): MessageInterface;
public function rawBuffer(): string;
}
100 changes: 15 additions & 85 deletions src/Http/Message/RequestInterface.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

namespace localzet\PSR\Http\Message;

use InvalidArgumentException;

/**
* Representation of an outgoing, client-side request.
*
Expand All @@ -28,107 +26,39 @@
interface RequestInterface extends MessageInterface
{
/**
* 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;
public function queryString(): string;

/**
* 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
* @return string
*/
public function withRequestTarget(string $requestTarget): RequestInterface;

public function uri(): string;

/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
* @return string
*/
public function getMethod(): string;
public function method(): string;

/**
* 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.
* Get http protocol version.
*
* @param string $method Case-sensitive method.
* @return static
* @throws InvalidArgumentException for invalid HTTP methods.
* @return string
*/
public function withMethod(string $method): RequestInterface;
public function protocolVersion(): string;

/**
* Retrieves the URI instance.
*
* This method MUST return a UriInterface instance.
* Get host.
*
* @link http://tools.ietf.org/html/rfc3986#section-4.3
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request.
* @param bool $withoutPort
* @return string|null
*/
public function getUri(): UriInterface;
public function host(bool $withoutPort = false): ?string;

/**
* Returns an instance with the provided URI.
* Get path.
*
* 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
* @return string
*/
public function withUri(UriInterface $uri, bool $preserveHost = false): RequestInterface;
public function path(): string;
}

0 comments on commit 6737e08

Please sign in to comment.