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.

AbstractInterface
ImplementsPsr\Http\Message\MessageInterface
Methods
public abstract Psr\Http\Message\MessageInterface::getBody()
 

Gets the body of the message.

public abstract Psr\Http\Message\MessageInterface::getHeader( $name)
 

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

This method returns an array of all the header values of the given
case-insensitive header name.

If the header does not appear in the message, this method MUST return an
empty array.

  • return 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.
public abstract Psr\Http\Message\MessageInterface::getHeaderLine( $name)
 

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given
case-insensitive header name as a string concatenated together using
a comma.

NOTE: Not all header values may be appropriately represented using
comma concatenation. For such headers, use getHeader() instead
and supply your own delimiter when concatenating.

If the header does not appear in the message, this method MUST return
an empty string.

  • return string A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.
public abstract Psr\Http\Message\MessageInterface::getHeaders()
 

Retrieves all message header values.

The keys represent the header name as it will be sent over the wire, and
each value is an array of strings associated with the header.

// Represent the headers as a string
foreach ($message->getHeaders() as $name => $values) {
    echo $name . ": " . implode(", ", $values);
}

// Emit headers iteratively:
foreach ($message->getHeaders() as $name => $values) {
    foreach ($values as $value) {
        header(sprintf('%s: %s', $name, $value), false);
    }
}

While header names are not case-sensitive, getHeaders() will preserve the
exact case in which headers were originally specified.

  • return 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.
public abstract getMethod()
 

Retrieves the HTTP method of the request.

  • return string Returns the request method.
public abstract Psr\Http\Message\MessageInterface::getProtocolVersion()
 

Retrieves the HTTP protocol version as a string.

The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").

  • return string HTTP protocol version.
public abstract 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 "/".

  • return string
public abstract getUri()
 

Retrieves the URI instance.

This method MUST return a UriInterface instance.

public abstract Psr\Http\Message\MessageInterface::hasHeader( $name)
 

Checks if a header exists by the given case-insensitive name.

  • return bool Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.
public abstract Psr\Http\Message\MessageInterface::withAddedHeader( $name, $value)
 

Return an instance with the specified header appended with the given value.

Existing values for the specified header will be maintained. The new
value(s) will be appended to the existing list. If the header did not
exist previously, it will be added.

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 header and/or value.

  • return static
  • throws InvalidArgumentException for invalid header names or values.
public abstract Psr\Http\Message\MessageInterface::withBody(Psr\Http\Message\StreamInterface $body)
 

Return an instance with the specified message body.

The body MUST be a StreamInterface object.

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
new body stream.

  • return static
  • throws InvalidArgumentException When the body is not valid.
public abstract Psr\Http\Message\MessageInterface::withHeader( $name, $value)
 

Return an instance with the provided value replacing the specified header.

While header names are case-insensitive, the casing of the header will
be preserved by this function, and returned from getHeaders().

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 and/or updated header and value.

  • return static
  • throws InvalidArgumentException for invalid header names or values.
public abstract 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.

  • return static
  • throws InvalidArgumentException for invalid HTTP methods.
public abstract Psr\Http\Message\MessageInterface::withoutHeader( $name)
 

Return an instance without the specified header.

Header resolution MUST be done without case-sensitivity.

This method MUST be implemented in such a way as to retain the
immutability of the message, and MUST return an instance that removes
the named header.

  • return static
public abstract Psr\Http\Message\MessageInterface::withProtocolVersion( $version)
 

Return an instance with the specified HTTP protocol version.

The version string MUST contain only the HTTP version number (e.g.,
"1.1", "1.0").

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 protocol version.

  • return static
public abstract 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.

public abstract withUri(Psr\Http\Message\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.

© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only