Interface RequestContract

Represents a Psr-7 request object.

Representation of an outgoing, client-side request.

Per the HTTP specification, this interface includes properties for each of the following:

Protocol version
HTTP method
URI
Headers
Message body

During construction, implementations MUST attempt to set the Host header from a provided URI if no Host header is provided.

Requests are considered immutable; all methods that might change state MUST be implemented such that they retain the internal state of the current message and return an instance that contains the changed state.

Contract interfaces enforce expected behavior in a non-colliding way. They are tasked with enforcing methods, and extending interfaces provided by standards and other packages for compatibility.

All valid oroboros classes MUST extend at

least one Contract Interface to be considered valid.

oroboros\core\interfaces\contract\libraries\request\RequestContract implements oroboros\core\interfaces\contract\libraries\stream\MessageContract, Psr\Http\Message\RequestInterface

Direct known implementers

oroboros\core\abstracts\libraries\request\AbstractRequest, oroboros\core\interfaces\contract\libraries\request\ServerRequestContract

Indirect known implementers

oroboros\core\abstracts\libraries\request\AbstractServerRequest, oroboros\core\libraries\request\Request, oroboros\core\libraries\request\ServerRequest

Namespace: oroboros\core\interfaces\contract\libraries\request
Package: oroboros\core\message
Category: contract-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4
Since: 0.2.4-alpha
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
Located at core/interfaces/contract/libraries/request/RequestContract.php

Methods summary

`public`	# `__construct( scalar\|resource\|Psr\Http\Message\StreamInterface $body, array $headers = null, type $protocol = null, $host = null, $uri = null, $method = null )` Constructs a new instance of a Psr-7 message wrapper. Constructs a new instance of a Psr-7 message wrapper. Parameters `$body` This is the only required value for the constructor, and represents a message body as a scalar value, resource pointer, or instance of a stream interface. `$headers` (optional) If provided, represents an array of headers to construct with the message. `$protocol` (optional) If provided, the HTTP request protocol will be set to this value. Default value is "1.1" `$host` `$uri` `$method` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if any passed parameters do not validate Implementation of `oroboros\core\interfaces\contract\libraries\stream\MessageContract::__construct()`
`public string`	# `getRequestTarget( )` Retrieves the message's request target. 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 "/". Returns string
`public static`	# `withRequestTarget( mixed $requestTarget )` 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 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. Parameters `$requestTarget` Returns static See http://tools.ietf.org/html/rfc7230#section-5.3 (for the various request-target forms allowed in request messages)
`public string`	# `getMethod( )` Retrieves the HTTP method of the request. Retrieves the HTTP method of the request. Returns string Returns the request method.
`public static`	# `withMethod( string $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 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. Parameters `$method` Case-sensitive method. Returns static Throws `InvalidArgumentException` for invalid HTTP methods.
`public UriInterface`	# `getUri( )` Retrieves the URI instance. Retrieves the URI instance. This method MUST return a UriInterface instance. Returns UriInterface Returns a UriInterface instance representing the URI of the request. See http://tools.ietf.org/html/rfc3986#section-4.3
`public static`	# `withUri( Psr\Http\Message\UriInterface $uri, boolean $preserveHost = false )` 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 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. Parameters `$uri` New request URI to use. `$preserveHost` Preserve the original state of the Host header. Returns static See http://tools.ietf.org/html/rfc3986#section-4.3

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\MessageContract

getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\StreamContract

__destruct(), __toString(), close(), detach(), eof(), getContents(), getMetadata(), getSize(), isReadable(), isSeekable(), isWritable(), read(), rewind(), seek(), tell(), write()

Namespaces

Interfaces

Interface RequestContract

least one Contract Interface to be considered valid.

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Throws

Implementation of

Returns

Parameters

Returns

See

Returns

Parameters

Returns

Throws

Returns

See

Parameters

Returns

See

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\MessageContract

Methods inherited from oroboros\core\interfaces\contract\libraries\stream\StreamContract