PHP Trait Zend\Diactoros\RequestTrait

Server and client-side requests differ slightly in how the Host header is handled; on client-side, it should be calculated on-the-fly from the composed URI (if present), while on server-side, it will be calculated from the environment. As such, this trait exists to provide the common code between both client-side and server-side requests, and each can then use the headers functionality required by their implementations.
Show file Open project: zendframework/zend-diactoros

Public Methods

Method Description
getMethod ( ) : string Retrieves the HTTP method of the request.
getRequestTarget ( ) : string Retrieves the message's request target.
getUri ( ) : Psr\Http\Message\UriInterface Retrieves the URI instance.
withMethod ( string $method ) : static Return an instance with the provided HTTP method.
withRequestTarget ( mixed $requestTarget ) : static Create a new instance with a specific request-target.
withUri ( Psr\Http\Message\UriInterface $uri, boolean $preserveHost = false ) : static Returns an instance with the provided URI.

Private Methods

Method Description
assertHeaders ( array $headers ) Ensure header names and values are valid.
createUri ( null | string | Psr\Http\Message\UriInterface $uri ) : Psr\Http\Message\UriInterface Create and return a URI instance.
getHostFromUri ( ) : string Retrieve the host from the URI instance
initialize ( null | string | Psr\Http\Message\UriInterface $uri = null, null | string $method = null, string | resource | Psr\Http\Message\StreamInterface $body = 'php://memory', array $headers = [] ) Initialize request state.
validateMethod ( null | string $method ) Validate the HTTP method

Method Details

getMethod() public method

Retrieves the HTTP method of the request.
public getMethod ( ) : string
return string Returns the request method.

getRequestTarget() public method

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 "/".
public getRequestTarget ( ) : string
return string

getUri() public method

This method MUST return a UriInterface instance.
See link: http://tools.ietf.org/html/rfc3986#section-4.3
public getUri ( ) : Psr\Http\Message\UriInterface
return Psr\Http\Message\UriInterface Returns a UriInterface instance representing the URI of the request, if any.

withMethod() public 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.
public withMethod ( string $method ) : static
$method string Case-insensitive method.
return static

withRequestTarget() public method

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 a new instance that has the changed request target.
See link: (for the various request-target forms allowed in request messages)
public withRequestTarget ( mixed $requestTarget ) : static
$requestTarget mixed
return static

withUri() public method

This method will 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 will 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, the returned request will not update the Host header of the returned message -- even if the message contains no Host header. This means that a call to getHeader('Host') on the original request MUST equal the return value of a call to getHeader('Host') on 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.
See link: http://tools.ietf.org/html/rfc3986#section-4.3
public withUri ( Psr\Http\Message\UriInterface $uri, boolean $preserveHost = false ) : static
$uri Psr\Http\Message\UriInterface New request URI to use.
$preserveHost boolean Preserve the original state of the Host header.
return static