PHPXRef 0.7.1 : phpBB-3.2.11-deutsch : Detail view of MessageInterface.php

Request and response message interface

Get a string representation of the message

return: string

Get the HTTP protocol version of the message

return: string

setBody(StreamInterface $body = null) X-Ref

Sets the body of the message.

The body MUST be a StreamInterface object. Setting the body to null MUST
remove the existing body.

param: StreamInterface|null $body Body.

getBody() X-Ref

Get the body of the message

return: StreamInterface|null

getHeaders() X-Ref

Gets all message headers.

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);
}

return: array Returns an associative array of the message's headers.

getHeader($header) X-Ref

Retrieve a header by the given case-insensitive name.

param: string $header Case-insensitive header name.
return: string

getHeaderAsArray($header) X-Ref

Retrieves a header by the given case-insensitive name as an array of strings.

param: string $header Case-insensitive header name.
return: string[]

hasHeader($header) X-Ref

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

param: string $header Case-insensitive header name.
return: bool Returns true if any header names match the given header

removeHeader($header) X-Ref

Remove a specific header by case-insensitive name.

param: string $header Case-insensitive header name.

addHeader($header, $value) X-Ref

Appends a header value to any existing values associated with the
given header name.

param: string $header Header name to add
param: string $value Value of the header

addHeaders(array $headers) X-Ref

Merges in an associative array of headers.

Each array key MUST be a string representing the case-insensitive name
of a header. Each value MUST be either a string or an array of strings.
For each value, the value is appended to any existing header of the same
name, or, if a header does not already exist by the given name, then the
header is added.

param: array $headers Associative array of headers to add to the message

setHeader($header, $value) X-Ref

Sets a header, replacing any existing values of any headers with the
same case-insensitive name.

The header values MUST be a string or an array of strings.

param: string $header Header name
param: string|array $value Header value(s)

setHeaders(array $headers) X-Ref

Sets headers, replacing any headers that have already been set on the
message.

The array keys MUST be a string. The array values must be either a
string or an array of strings.

param: array $headers Headers to set.

File Size:	136 lines (4 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of phpBB-3.2.11-deutsch

/vendor/guzzlehttp/guzzle/src/Message/ -> MessageInterface.php (summary)

Defines 1 class