GuzzleHttp\Psr7\Request Class Reference

PSR-7 request implementation. More...

Inheritance diagram for GuzzleHttp\Psr7\Request:

Collaboration diagram for GuzzleHttp\Psr7\Request:

Public Member Functions
	__construct ( $method, $uri, array $headers=[], $body=null, $version='1.1')
	getRequestTarget ()
	Retrieves the message's request target. More...
	withRequestTarget ($requestTarget)
	Return an instance with the specific request-target. More...
	getMethod ()
	Retrieves the HTTP method of the request. More...
	withMethod ($method)
	Return an instance with the provided HTTP method. More...
	getUri ()
	Retrieves the URI instance. More...
	withUri (UriInterface $uri, $preserveHost=false)
	Returns an instance with the provided URI. More...
Public Member Functions inherited from Psr\Http\Message\MessageInterface
	getProtocolVersion ()
	Retrieves the HTTP protocol version as a string. More...
	withProtocolVersion ($version)
	Return an instance with the specified HTTP protocol version. More...
	getHeaders ()
	Retrieves all message header values. More...
	hasHeader ($name)
	Checks if a header exists by the given case-insensitive name. More...
	getHeader ($name)
	Retrieves a message header value by the given case-insensitive name. More...
	getHeaderLine ($name)
	Retrieves a comma-separated string of the values for a single header. More...
	withHeader ($name, $value)
	Return an instance with the provided value replacing the specified header. More...
	withAddedHeader ($name, $value)
	Return an instance with the specified header appended with the given value. More...
	withoutHeader ($name)
	Return an instance without the specified header. More...
	getBody ()
	Gets the body of the message. More...
	withBody (StreamInterface $body)
	Return an instance with the specified message body. More...

Private Member Functions
	updateHostFromUri ()

Private Attributes
	$method
	$requestTarget
	$uri

Detailed Description

PSR-7 request implementation.

Definition at line 12 of file Request.php.

Constructor & Destructor Documentation

__construct()

GuzzleHttp\Psr7\Request::__construct	(		$method,
			$uri,
		array	$headers = [],
			$body = null,
			$version = '1.1'
	)

Parameters

string	$method	HTTP method
string | UriInterface	$uri	URI
array	$headers	Request headers
string | null | resource | StreamInterface	$body	Request body
string	$version	Protocol version

Definition at line 32 of file Request.php.

References GuzzleHttp\Psr7\Request\$method, GuzzleHttp\Psr7\Request\$uri, $version, Psr\Http\Message\MessageInterface\hasHeader(), GuzzleHttp\Psr7\setHeaders(), GuzzleHttp\Psr7\stream_for(), and GuzzleHttp\Psr7\Request\updateHostFromUri().

      {
        if (!($uri instanceof UriInterface)) {
            $uri = new Uri($uri);
        }

        $this->method = strtoupper($method);
        $this->uri = $uri;
        $this->setHeaders($headers);
        $this->protocol = $version;

        if (!$this->hasHeader('Host')) {
            $this->updateHostFromUri();
        }

        if ($body !== '' && $body !== null) {
            $this->stream = stream_for($body);
        }
    }

Here is the call graph for this function:

Member Function Documentation

getMethod()

GuzzleHttp\Psr7\Request::getMethod

(

)

Retrieves the HTTP method of the request.

Returns

string Returns the request method.

Implements Psr\Http\Message\RequestInterface.

Definition at line 87 of file Request.php.

References GuzzleHttp\Psr7\Request\$method.

    {
        return $this->method;
    }

getRequestTarget()

GuzzleHttp\Psr7\Request::getRequestTarget

(

)

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

Implements Psr\Http\Message\RequestInterface.

Definition at line 57 of file Request.php.

References GuzzleHttp\Psr7\Request\$requestTarget, and $target.

    {
        if ($this->requestTarget !== null) {
            return $this->requestTarget;
        }

        $target = $this->uri->getPath();
        if ($target == '') {
            $target = '/';
        }
        if ($this->uri->getQuery() != '') {
            $target .= '?' . $this->uri->getQuery();
        }

        return $target;
    }

getUri()

GuzzleHttp\Psr7\Request::getUri

(

)

Retrieves the URI instance.

This method MUST return a UriInterface instance.

UriInterface Returns a UriInterface instance representing the URI of the request.

Implements Psr\Http\Message\RequestInterface.

Definition at line 99 of file Request.php.

References GuzzleHttp\Psr7\Request\$uri.

    {
        return $this->uri;
    }

updateHostFromUri()

GuzzleHttp\Psr7\Request::updateHostFromUri ( )

private

Definition at line 120 of file Request.php.

References $header.

Referenced by GuzzleHttp\Psr7\Request\__construct().

    {
        $host = $this->uri->getHost();

        if ($host == '') {
            return;
        }

        if (($port = $this->uri->getPort()) !== null) {
            $host .= ':' . $port;
        }

        if (isset($this->headerNames['host'])) {
            $header = $this->headerNames['host'];
        } else {
            $header = 'Host';
            $this->headerNames['host'] = 'Host';
        }
        // Ensure Host is the first header.
        // See: http://tools.ietf.org/html/rfc7230#section-5.4
        $this->headers = [$header => [$host]] + $this->headers;
    }

Here is the caller graph for this function:

withMethod()

GuzzleHttp\Psr7\Request::withMethod

(

$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

string

$method

Case-sensitive method.

Returns

static

Exceptions

Implements Psr\Http\Message\RequestInterface.

Definition at line 92 of file Request.php.

References GuzzleHttp\Psr7\Request\$method.

    {
        $new = clone $this;
        $new->method = strtoupper($method);
        return $new;
    }

withRequestTarget()

GuzzleHttp\Psr7\Request::withRequestTarget

(

$requestTarget

)

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.

(for the various request-target forms allowed in request messages) mixed $requestTarget static

Implements Psr\Http\Message\RequestInterface.

Definition at line 74 of file Request.php.

References GuzzleHttp\Psr7\Request\$requestTarget.

    {
        if (preg_match('#\s#', $requestTarget)) {
            throw new InvalidArgumentException(
                'Invalid request target provided; cannot contain whitespace'
            );
        }

        $new = clone $this;
        $new->requestTarget = $requestTarget;
        return $new;
    }

withUri()

GuzzleHttp\Psr7\Request::withUri	(	UriInterface	$uri,
			$preserveHost = false
	)

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.

UriInterface $uri New request URI to use. bool $preserveHost Preserve the original state of the Host header. static

Implements Psr\Http\Message\RequestInterface.

Definition at line 104 of file Request.php.

References GuzzleHttp\Psr7\Request\$uri.

    {
        if ($uri === $this->uri) {
            return $this;
        }

        $new = clone $this;
        $new->uri = $uri;

        if (!$preserveHost) {
            $new->updateHostFromUri();
        }

        return $new;
    }

Field Documentation

$method

GuzzleHttp\Psr7\Request::$method

private

Definition at line 17 of file Request.php.

Referenced by GuzzleHttp\Psr7\Request\__construct(), GuzzleHttp\Psr7\ServerRequest\__construct(), GuzzleHttp\Psr7\ServerRequest\fromGlobals(), GuzzleHttp\Psr7\Request\getMethod(), and GuzzleHttp\Psr7\Request\withMethod().

$requestTarget

GuzzleHttp\Psr7\Request::$requestTarget

private

Definition at line 20 of file Request.php.

Referenced by GuzzleHttp\Psr7\Request\getRequestTarget(), and GuzzleHttp\Psr7\Request\withRequestTarget().

$uri

GuzzleHttp\Psr7\Request::$uri

private

Definition at line 23 of file Request.php.

Referenced by GuzzleHttp\Psr7\Request\__construct(), GuzzleHttp\Psr7\ServerRequest\__construct(), GuzzleHttp\Psr7\ServerRequest\fromGlobals(), GuzzleHttp\Psr7\Request\getUri(), GuzzleHttp\Psr7\ServerRequest\getUriFromGlobals(), and GuzzleHttp\Psr7\Request\withUri().

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/guzzlehttp/psr7/src/Request.php