Fr3nch13/CakePHP Utilities

MessageTrait

Trait implementing the various methods defined in MessageInterface.

Tags
see
https://github.com/php-fig/http-message/tree/master/src/MessageInterface.php

Table of Contents

Properties

$headerNames  : array<string|int, mixed>
Map of normalized header name to original name used to register header.
$headers  : array<string|int, mixed>
List of all registered headers, as key => array of values.
$protocol  : string
$stream  : StreamInterface

Methods

getBody()  : StreamInterface
Gets the body of the message.
getHeader()  : array<string|int, string>
Retrieves a message header value by the given case-insensitive name.
getHeaderLine()  : string
Retrieves a comma-separated string of the values for a single header.
getHeaders()  : array<string|int, mixed>
Retrieves all message headers.
getProtocolVersion()  : string
Retrieves the HTTP protocol version as a string.
hasHeader()  : bool
Checks if a header exists by the given case-insensitive name.
withAddedHeader()  : static
Return an instance with the specified header appended with the given value.
withBody()  : static
Return an instance with the specified message body.
withHeader()  : static
Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.
withoutHeader()  : static
Return an instance without the specified header.
withProtocolVersion()  : static
Return an instance with the specified HTTP protocol version.
assertHeader()  : void
Ensure header name and values are valid.
filterHeaderValue()  : array<int, string>
getStream()  : StreamInterface
setHeaders()  : void
Filter a set of headers to ensure they are in the correct internal format.
validateProtocolVersion()  : void
Validate the HTTP protocol version

Properties

$headerNames

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

protected array<string|int, mixed> $headerNames = []
Tags
psalm-var

array<non-empty-string, non-empty-string>

$headers

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

protected array<string|int, mixed> $headers = []
Tags
psalm-var

array<non-empty-string, list>

Methods

getHeader()

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

public getHeader(string $header) : array<string|int, string>

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.

Parameters
$header : string

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.

getHeaderLine()

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

public getHeaderLine(string $name) : string

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.

Parameters
$name : string

Case-insensitive header field name.

Return values
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.

getHeaders()

Retrieves all message headers.

public getHeaders() : array<string|int, mixed>

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);
    }
}
Tags
psalm-return

array<non-empty-string, list>

Return values
array<string|int, mixed> —

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()

Retrieves the HTTP protocol version as a string.

public getProtocolVersion() : string

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

Return values
string —

HTTP protocol version.

hasHeader()

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

public hasHeader(string $header) : bool
Parameters
$header : string

Case-insensitive header name.

Return values
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.

withAddedHeader()

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

public withAddedHeader(string $name, string|array<string|int, string> $value) : static

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.

Parameters
$name : string

Case-insensitive header field name to add.

$value : string|array<string|int, string>

Header value(s).

Tags
throws
InvalidArgumentException

For invalid header names or values.

Return values
static

withBody()

Return an instance with the specified message body.

public withBody(StreamInterface $body) : static

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.

Parameters
$body : StreamInterface

Body.

Tags
throws
InvalidArgumentException

When the body is not valid.

Return values
static

withHeader()

Return an instance with the provided header, replacing any existing values of any headers with the same case-insensitive name.

public withHeader(string $name, string|array<string|int, string> $value) : static

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.

Parameters
$name : string

Case-insensitive header field name.

$value : string|array<string|int, string>

Header value(s).

Tags
throws
InvalidArgumentException

For invalid header names or values.

Return values
static

withoutHeader()

Return an instance without the specified header.

public withoutHeader(string $name) : static

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.

Parameters
$name : string

Case-insensitive header field name to remove.

Return values
static

withProtocolVersion()

Return an instance with the specified HTTP protocol version.

public withProtocolVersion(string $version) : static

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.

Parameters
$version : string

HTTP protocol version

Return values
static

filterHeaderValue()

private filterHeaderValue(mixed $values) : array<int, string>
Parameters
$values : mixed
Return values
array<int, string>

setHeaders()

Filter a set of headers to ensure they are in the correct internal format.

private setHeaders(array<string|int, mixed> $originalHeaders) : void

Used by message constructors to allow setting all initial headers at once.

Parameters
$originalHeaders : array<string|int, mixed>

Headers to filter.

validateProtocolVersion()

Validate the HTTP protocol version

private validateProtocolVersion(string $version) : void
Parameters
$version : string
Tags
throws
InvalidArgumentException

On invalid HTTP protocol version.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results