Interface MessageInterface
Request and response message interface
Direct known implementers
Guzzle\Http\Message\AbstractMessage,
Guzzle\Http\Message\RequestInterface
Indirect known implementers
Guzzle\Http\Message\EntityEnclosingRequest,
Guzzle\Http\Message\EntityEnclosingRequestInterface,
Guzzle\Http\Message\Request,
Guzzle\Http\Message\Response
Methods summary
-
publicgetParams ( )Get application and plugin specific parameters set on the message.
-
publicaddHeader ( string $header, string $value )Add a header to an existing collection of headers.
-
publicaddHeaders ( array $headers )Add and merge in an array of HTTP headers.
-
publicgetHeader ( string $header )Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
-
publicgetHeaders ( )Get all headers as a collection
-
publichasHeader ( string $header )Check if the specified header is present.
-
publicremoveHeader ( string $header )Remove a specific HTTP header.
-
publicsetHeader ( string $header, mixed $value )Set an HTTP header and overwrite any existing value for the header
-
publicsetHeaders ( array $headers )Overwrite all HTTP headers with the supplied array of headers
-
publicgetHeaderLines ( )Get an array of message header lines (e.g. ["Host: example.com", ...])
-
publicgetRawHeaders ( )Get the raw message headers as a string
Methods detail
Add a header to an existing collection of headers.
Parameters
- $header
string
$header Header name to add- $value
string
$value Value of the header
Returns
Add and merge in an array of HTTP headers.
Parameters
- $headers
array
$headers Associative array of header data.
Returns
Retrieve an HTTP header by name. Performs a case-insensitive search of all headers.
Parameters
- $header
string
$header Header to retrieve.
Returns
Check if the specified header is present.
Parameters
- $header
string
$header The header to check.
Returns
booleanRemove a specific HTTP header.
Parameters
- $header
string
$header HTTP header to remove.
Returns
Set an HTTP header and overwrite any existing value for the header
Parameters
- $header
string
$header Name of the header to set.- $value
mixed
$value Value to set.
Returns
Overwrite all HTTP headers with the supplied array of headers
Parameters
- $headers
array
$headers Associative array of header data.
Returns
Get an array of message header lines (e.g. ["Host: example.com", ...])
Returns
arrayGet the raw message headers as a string
Returns
string