Documentation

MessageInterface
in

Request and response message interface

Table of Contents

Methods

addHeader()  : self
Add a header to an existing collection of headers.
addHeaders()  : self
Add and merge in an array of HTTP headers.
getHeader()  : Header|null
Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
getHeaderLines()  : array<string|int, mixed>
Get an array of message header lines (e.g. ["Host: example.com", ...])
getHeaders()  : HeaderCollection
Get all headers as a collection
getParams()  : Collection
Get application and plugin specific parameters set on the message.
getRawHeaders()  : string
Get the raw message headers as a string
hasHeader()  : bool
Check if the specified header is present.
removeHeader()  : self
Remove a specific HTTP header.
setHeader()  : self
Set an HTTP header and overwrite any existing value for the header
setHeaders()  : self
Overwrite all HTTP headers with the supplied array of headers

Methods

addHeader()

Add a header to an existing collection of headers.

public addHeader(string $header, string $value) : self
Parameters
$header : string

Header name to add

$value : string

Value of the header

Return values
self

addHeaders()

Add and merge in an array of HTTP headers.

public addHeaders(array<string|int, mixed> $headers) : self
Parameters
$headers : array<string|int, mixed>

Associative array of header data.

Return values
self

getHeader()

Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.

public getHeader(string $header) : Header|null
Parameters
$header : string

Header to retrieve.

Return values
Header|null

getHeaderLines()

Get an array of message header lines (e.g. ["Host: example.com", ...])

public getHeaderLines() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRawHeaders()

Get the raw message headers as a string

public getRawHeaders() : string
Return values
string

hasHeader()

Check if the specified header is present.

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

The header to check.

Return values
bool

removeHeader()

Remove a specific HTTP header.

public removeHeader(string $header) : self
Parameters
$header : string

HTTP header to remove.

Return values
self

setHeader()

Set an HTTP header and overwrite any existing value for the header

public setHeader(string $header, mixed $value) : self
Parameters
$header : string

Name of the header to set.

$value : mixed

Value to set.

Return values
self

setHeaders()

Overwrite all HTTP headers with the supplied array of headers

public setHeaders(array<string|int, mixed> $headers) : self
Parameters
$headers : array<string|int, mixed>

Associative array of header data.

Return values
self 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results