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

Namespace: Guzzle\Http\Message
Located at Guzzle/Http/Message/MessageInterface.php

Methods summary
`public Guzzle\Common\Collection`	# `getParams( )` Get application and plugin specific parameters set on the message. Get application and plugin specific parameters set on the message. Returns `Guzzle\Common\Collection`
`public Guzzle\Http\Message\MessageInterface`	# `addHeader( string $header, string $value )` Add a header to an existing collection of headers. 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 `Guzzle\Http\Message\MessageInterface`
`public Guzzle\Http\Message\MessageInterface`	# `addHeaders( array $headers )` Add and merge in an array of HTTP headers. Add and merge in an array of HTTP headers. Parameters `$headers` `array` $headers Associative array of header data. Returns `Guzzle\Http\Message\MessageInterface`
`public string\|Guzzle\Http\Message\Header\|null`	# `getHeader( string $header, boolean $string = false )` Retrieve an HTTP header by name. Performs a case-insensitive search of all headers. Retrieve an HTTP header by name. Performs a case-insensitive search of all headers. Parameters `$header` `string` $header Header to retrieve. `$string` `boolean` $string Set to true to get the header as a string Returns `string\|Guzzle\Http\Message\Header\|null` Returns NULL if no matching header is found. Returns a string if $string is set to TRUE. Returns a Header object if a matching header is found.
`public Guzzle\Common\Collection\|null`	# `getTokenizedHeader( string $header, string $token = ';' )` Get a tokenized header as a Collection Get a tokenized header as a Collection Parameters `$header` `string` $header Header to retrieve `$token` `string` $token Token separator Returns `Guzzle\Common\Collection\|null`
`public Guzzle\Http\Message\MessageInterface`	# `setTokenizedHeader( string $header, array\|Guzzle\Common\Collection $data, string $token = ';' )` Set a tokenized header on the request that implodes a Collection of data into a string separated by a token. Set a tokenized header on the request that implodes a Collection of data into a string separated by a token. Parameters `$header` `string` $header Header to set `$data` `array\|Guzzle\Common\Collection` $data Header data `$token` `string` $token Token delimiter Returns `Guzzle\Http\Message\MessageInterface` Throws `Guzzle\Common\Exception\InvalidArgumentException` if data is not an array or Collection
`public Guzzle\Common\Collection`	# `getHeaders( boolean $asObjects = false )` Get all headers as a collection Get all headers as a collection Parameters `$asObjects` `boolean` $asObjects Set to true to retrieve a collection of Header objects Returns `Guzzle\Common\Collection` Returns a `Guzzle\Common\Collection` of all headers
`public array`	# `getHeaderLines( )` Get an array of message header lines Get an array of message header lines Returns `array`
`public boolean`	# `hasHeader( string $header )` Check if the specified header is present. Check if the specified header is present. Parameters `$header` `string` $header The header to check. Returns `boolean` Returns TRUE or FALSE if the header is present
`public Guzzle\Http\Message\MessageInterface`	# `removeHeader( string $header )` Remove a specific HTTP header. Remove a specific HTTP header. Parameters `$header` `string` $header HTTP header to remove. Returns `Guzzle\Http\Message\MessageInterface`
`public Guzzle\Http\Message\MessageInterface`	# `setHeader( string $header, mixed $value )` Set an HTTP header Set an HTTP header Parameters `$header` `string` $header Name of the header to set. `$value` `mixed` $value Value to set. Returns `Guzzle\Http\Message\MessageInterface`
`public Guzzle\Http\Message\MessageInterface`	# `setHeaders( array $headers )` Overwrite all HTTP headers with the supplied array of headers Overwrite all HTTP headers with the supplied array of headers Parameters `$headers` `array` $headers Associative array of header data. Returns `Guzzle\Http\Message\MessageInterface`
`public string`	# `getRawHeaders( )` Get the raw message headers as a string Get the raw message headers as a string Returns `string`
`public null\|string`	# `getCacheControlDirective( string $directive )` Get a Cache-Control directive from the message Get a Cache-Control directive from the message Parameters `$directive` `string` $directive Directive to retrieve Returns `null\|string`
`public boolean`	# `hasCacheControlDirective( string $directive )` Check if the message has a Cache-Control directive Check if the message has a Cache-Control directive Parameters `$directive` `string` $directive Directive to check Returns `boolean`
`public Guzzle\Http\Message\MessageInterface`	# `addCacheControlDirective( string $directive, boolean\|string $value = true )` Add a Cache-Control directive on the message Add a Cache-Control directive on the message Parameters `$directive` `string` $directive Directive to set `$value` `boolean\|string` $value Value to set Returns `Guzzle\Http\Message\MessageInterface`
`public Guzzle\Http\Message\MessageInterface`	# `removeCacheControlDirective( string $directive )` Remove a Cache-Control directive from the message Remove a Cache-Control directive from the message Parameters `$directive` `string` $directive Directive to remove Returns `Guzzle\Http\Message\MessageInterface`