Fr3nch13/CakePHP Utilities

Request
in package
implements RequestInterface uses RequestTrait

HTTP Request encapsulation

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

Table of Contents

Interfaces

RequestInterface
Representation of an outgoing, client-side request.

Properties

$method  : string
$requestTarget  : null|string
The request-target, if it has been provided or calculated.
$uri  : UriInterface

Methods

__construct()  : mixed
getHeader()  : array<string|int, string>
Retrieves a message header value by the given case-insensitive name.
getHeaders()  : array<string|int, array<string|int, string>>
Retrieves all message header values.
getMethod()  : string
Retrieves the HTTP method of the request.
getRequestTarget()  : string
Retrieves the message's request target.
getUri()  : UriInterface
Retrieves the URI instance.
withMethod()  : static
Return an instance with the provided HTTP method.
withRequestTarget()  : static
Create a new instance with a specific request-target.
withUri()  : static
Returns an instance with the provided URI.
createUri()  : UriInterface
Create and return a URI instance.
getHostFromUri()  : string
Retrieve the host from the URI instance
initialize()  : void
Initialize request state.
setMethod()  : void
Set and validate the HTTP method

Properties

$requestTarget

The request-target, if it has been provided or calculated.

private null|string $requestTarget

Methods

__construct()

public __construct([null|string|UriInterface $uri = null ][, null|string $method = null ][, string|resource|StreamInterface $body = 'php://temp' ][, array<string|int, mixed> $headers = [] ]) : mixed
Parameters
$uri : null|string|UriInterface = null

URI for the request, if any.

$method : null|string = null

HTTP method for the request, if any.

$body : string|resource|StreamInterface = 'php://temp'

Message body, if any.

$headers : array<string|int, mixed> = []

Headers for the message, if any.

Tags
throws
InvalidArgumentException

For any invalid value.

getHeader()

Retrieves a message header value by the given case-insensitive name.

public getHeader(mixed $name) : array<string|int, string>
Parameters
$name : mixed

Case-insensitive header field name.

Return values
array<string|int, 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.

getHeaders()

Retrieves all message header values.

public getHeaders() : array<string|int, array<string|int, string>>
Return values
array<string|int, array<string|int, 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.

getMethod()

Retrieves the HTTP method of the request.

public getMethod() : string
Return values
string —

Returns the request method.

getRequestTarget()

Retrieves the message's request target.

public getRequestTarget() : string

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 values
string

withMethod()

Return an instance with the provided HTTP method.

public withMethod(string $method) : static

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 : string

Case-insensitive method.

Tags
throws
InvalidArgumentException

For invalid HTTP methods.

Return values
static

withRequestTarget()

Create a new instance with a specific request-target.

public withRequestTarget(string $requestTarget) : static

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
$requestTarget : string
Tags
link

(for the various request-target forms allowed in request messages)
throws
InvalidArgumentException

If the request target is invalid.

Return values
static

withUri()

Returns an instance with the provided URI.

public withUri(UriInterface $uri[, bool $preserveHost = false ]) : static

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
$uri : UriInterface

New request URI to use.

$preserveHost : bool = false

Preserve the original state of the Host header.

Tags
link
http://tools.ietf.org/html/rfc3986#section-4.3
Return values
static

createUri()

Create and return a URI instance.

private createUri(null|string|UriInterface $uri) : UriInterface

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 empty Uri` instance.

Otherwise, it raises an exception.

Parameters
$uri : null|string|UriInterface
Tags
throws
InvalidArgumentException
Return values
UriInterface

getHostFromUri()

Retrieve the host from the URI instance

private getHostFromUri() : string
Return values
string

initialize()

Initialize request state.

private initialize([null|string|UriInterface $uri = null ][, null|string $method = null ][, string|resource|StreamInterface $body = 'php://memory' ][, array<string|int, mixed> $headers = [] ]) : void

Used by constructors.

Parameters
$uri : null|string|UriInterface = null

URI for the request, if any.

$method : null|string = null

HTTP method for the request, if any.

$body : string|resource|StreamInterface = 'php://memory'

Message body, if any.

$headers : array<string|int, mixed> = []

Headers for the message, if any.

Tags
throws
InvalidArgumentException

For any invalid value.

setMethod()

Set and validate the HTTP method

private setMethod(string $method) : void
Parameters
$method : string
Tags
throws
InvalidArgumentException

On invalid HTTP method.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results