PHP Trait Phly\Http\MessageTrait

See link: https://github.com/php-fig/http-message/tree/master/src/MessageInterface.php

Protected Properties

Property	Type	Description
$headerNames	array	Map of normalized header name to original name used to register header.
$headers	array	List of all registered headers, as key => array of values.

Public Methods

Method	Description
getBody ( ) : Psr\Http\Message\StreamInterface	Gets the body of the message.
getHeader ( $header ) : string[]	Retrieves a message header value by the given case-insensitive name.
getHeaderLine ( $header ) : string \| null	Retrieves the line for a single header, with the header values as a comma-separated string.
getHeaders ( ) : array	Retrieves all message headers.
getProtocolVersion ( ) : string	Retrieves the HTTP protocol version as a string.
hasHeader ( string $header ) : boolean	Checks if a header exists by the given case-insensitive name.
withAddedHeader ( $header, string \| string[] $value ) : self	Return an instance with the specified header appended with the given value.
withBody ( Psr\Http\Message\StreamInterface $body ) : self	Return an instance with the specified message body.
withHeader ( $header, string \| string[] $value ) : self	Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
withProtocolVersion ( string $version ) : self	Return an instance with the specified HTTP protocol version.
withoutHeader ( $header ) : self	Return an instance without the specified header.

Private Methods

Method	Description
arrayContainsOnlyStrings ( array $array ) : boolean	Test that an array contains only strings
assertValidHeaderValue ( array $values )	Assert that the provided header values are valid.
filterHeaders ( array $originalHeaders ) : array	Filter a set of headers to ensure they are in the correct internal format.
filterStringValue ( boolean $carry, mixed $item ) : boolean	Test if a value is a string

Method Details

getBody() public method

Gets the body of the message.

public getBody ( ) : Psr\Http\Message\StreamInterface
return	Psr\Http\Message\StreamInterface	Returns the body as a stream.

getHeader() public method

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.

public getHeader ( $header ) : string[]
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.

getHeaderLine() public method

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 a null value.

public getHeaderLine ( $header ) : string \| null
return	string \| null	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 a null value.

getHeaders() public method

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

public getHeaders ( ) : array
return	array	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.

getProtocolVersion() public method

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

public getProtocolVersion ( ) : string
return	string	HTTP protocol version.

hasHeader() public method

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

public hasHeader ( string $header ) : boolean
$header	string	Case-insensitive header name.
return	boolean	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.

withAddedHeader() public method

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.

public withAddedHeader ( $header, string \| string[] $value ) : self
$value	string \| string[]	Header value(s).
return	self

withBody() public method

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.

public withBody ( Psr\Http\Message\StreamInterface $body ) : self
$body	Psr\Http\Message\StreamInterface	Body.
return	self

withHeader() public method

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.

public withHeader ( $header, string \| string[] $value ) : self
$value	string \| string[]	Header value(s).
return	self

withProtocolVersion() public method

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.

public withProtocolVersion ( string $version ) : self
$version	string	HTTP protocol version
return	self

withoutHeader() public method

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.

public withoutHeader ( $header ) : self
return	self

Property Details

$headerNames protected_oe property

Map of normalized header name to original name used to register header.

protected array $headerNames
return	array

$headers protected_oe property

List of all registered headers, as key => array of values.

protected array $headers
return	array