\Zend\DiactorosRequest

getRequestTarget()

getRequestTarget() : string

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

withRequestTarget()

withRequestTarget(mixed  $requestTarget) : static

Create a new instance with a 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 a new instance that has the changed request target.

Parameters

Throws

\InvalidArgumentException

if the request target is invalid.

Returns

getMethod()

getMethod() : string

Retrieves the HTTP method of the request.

Returns

Returns the request method.

withMethod()

withMethod(string  $method) : static

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

Throws

\InvalidArgumentException

for invalid HTTP methods.

Returns

getUri()

getUri() : \Psr\Http\Message\UriInterface

Retrieves the URI instance.

This method MUST return a UriInterface instance.

Returns

Returns a UriInterface instance representing the URI of the request, if any.

withUri()

withUri(\Psr\Http\Message\UriInterface  $uri, boolean  $preserveHost = false) : static

Returns an instance with the provided URI.

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.

Parameters

Returns

__construct()

__construct(null|string|\Psr\Http\Message\UriInterface  $uri = null, null|string  $method = null, string|resource|\Psr\Http\Message\StreamInterface  $body = 'php://temp', array  $headers = array()) 

Parameters

Throws

\InvalidArgumentException

for any invalid value.

getHeaders()

getHeaders() 

{@inheritdoc}

getHeader()

getHeader(  $header) 

{@inheritdoc}

Parameters

initialize()

initialize(null|string|\Psr\Http\Message\UriInterface  $uri = null, null|string  $method = null, string|resource|\Psr\Http\Message\StreamInterface  $body = 'php://memory', array  $headers = array()) 

Initialize request state.

Used by constructors.

Parameters

Throws

\InvalidArgumentException

for any invalid value.

createUri()

createUri(null|string|\Psr\Http\Message\UriInterface  $uri) : \Psr\Http\Message\UriInterface

Create and return a URI instance.

If $uri is a already a UriInterface instance, returns it.

If $uri is a string, passes it to the Uri constructor to return an instance.

If $uri is null, creates and returns an emptyUri` instance.

Otherwise, it raises an exception.

Parameters

Throws

\InvalidArgumentException

Returns

validateMethod()

validateMethod(null|string  $method) 

Validate the HTTP method

Parameters

Throws

\InvalidArgumentException

on invalid HTTP method.

getHostFromUri()

getHostFromUri() : string

Retrieve the host from the URI instance

Returns