Guzzle\Http\Message\AbstractMessage Class Reference

Inheritance diagram for Guzzle\Http\Message\AbstractMessage:

Public Member Functions
	__construct ()
	addCacheControlDirective ($directive, $value=true)
	addHeader ($header, $value)
	addHeaders (array $headers)
	getCacheControlDirective ($directive)
	getHeader ($header)
	getHeaderLines ()
	getHeaders ()
	getParams ()
	getTokenizedHeader ($header, $token=';')
	hasCacheControlDirective ($directive)
	hasHeader ($header)
	removeCacheControlDirective ($directive)
	removeHeader ($header)
	setHeader ($header, $value)
	setHeaderFactory (HeaderFactoryInterface $factory)
	setHeaders (array $headers)
	setTokenizedHeader ($header, $data, $token=';')
Public Member Functions inherited from Guzzle\Http\Message\MessageInterface
	getRawHeaders ()

Protected Attributes
	$headerFactory
	$headers
	$params
	$protocol = 'HTTP'
	$protocolVersion = '1.1'

Detailed Description

Abstract HTTP request/response message

Definition at line 15 of file AbstractMessage.php.

Constructor & Destructor Documentation

__construct()

Guzzle\Http\Message\AbstractMessage::__construct

(

)

Definition at line 47 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Response\unserialize().

Member Function Documentation

addCacheControlDirective()

Guzzle\Http\Message\AbstractMessage::addCacheControlDirective	(		$directive,
			$value = true
	)

Deprecated:

@codeCoverageIgnore

Definition at line 209 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\addHeader(), Guzzle\Http\Message\AbstractMessage\getHeader(), and Guzzle\Common\Version\warn().

addHeader()

Guzzle\Http\Message\AbstractMessage::addHeader	(		$header,
			$value
	)

Add a header to an existing collection of headers.

Parameters

string	$header	Header name to add
string	$value	Value of the header

Returns

self

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 73 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Request\__construct(), Guzzle\Http\Message\AbstractMessage\addCacheControlDirective(), Guzzle\Http\Message\AbstractMessage\addHeaders(), Guzzle\Http\Message\AbstractMessage\setHeader(), and Guzzle\Http\Message\AbstractMessage\setHeaders().

addHeaders()

Guzzle\Http\Message\AbstractMessage::addHeaders

(

array

$headers

)

Add and merge in an array of HTTP headers.

Parameters

array

$headers

Associative array of header data.

Returns

self

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 86 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\$headers, and Guzzle\Http\Message\AbstractMessage\addHeader().

getCacheControlDirective()

Guzzle\Http\Message\AbstractMessage::getCacheControlDirective

(

$directive

)

Deprecated:

@codeCoverageIgnore

Definition at line 181 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), and Guzzle\Common\Version\warn().

getHeader()

Guzzle\Http\Message\AbstractMessage::getHeader

(

$header

)

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

Parameters

string

$header

Header to retrieve.

Returns

Header|null

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 95 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\AbstractMessage\addCacheControlDirective(), Guzzle\Http\Message\Request\addCookie(), Guzzle\Http\Message\Response\calculateAge(), Guzzle\Http\Message\Response\canCache(), Guzzle\Http\Message\Response\getAcceptRanges(), Guzzle\Http\Message\Response\getAge(), Guzzle\Http\Message\Response\getAllow(), Guzzle\Http\Message\Response\getCacheControl(), Guzzle\Http\Message\AbstractMessage\getCacheControlDirective(), Guzzle\Http\Message\Response\getConnection(), Guzzle\Http\Message\Response\getContentDisposition(), Guzzle\Http\Message\Response\getContentEncoding(), Guzzle\Http\Message\Response\getContentLanguage(), Guzzle\Http\Message\Response\getContentLength(), Guzzle\Http\Message\Response\getContentLocation(), Guzzle\Http\Message\Response\getContentMd5(), Guzzle\Http\Message\Response\getContentRange(), Guzzle\Http\Message\Response\getContentType(), Guzzle\Http\Message\Request\getCookies(), Guzzle\Http\Message\Response\getDate(), Guzzle\Http\Message\Response\getEtag(), Guzzle\Http\Message\Response\getExpires(), Guzzle\Http\Message\Response\getLastModified(), Guzzle\Http\Message\Response\getLocation(), Guzzle\Http\Message\Response\getMaxAge(), Guzzle\Http\Message\Response\getPragma(), Guzzle\Http\Message\Response\getProxyAuthenticate(), Guzzle\Http\Message\Response\getRetryAfter(), Guzzle\Http\Message\Response\getServer(), Guzzle\Http\Message\Response\getSetCookie(), Guzzle\Http\Message\AbstractMessage\getTokenizedHeader(), Guzzle\Http\Message\Response\getTrailer(), Guzzle\Http\Message\Response\getTransferEncoding(), Guzzle\Http\Message\Response\getVary(), Guzzle\Http\Message\Response\getVia(), Guzzle\Http\Message\Response\getWarning(), Guzzle\Http\Message\Response\getWwwAuthenticate(), Guzzle\Plugin\Cache\DefaultRevalidation\handle304Response(), Guzzle\Http\Message\AbstractMessage\hasCacheControlDirective(), Guzzle\Http\Message\Response\isContentType(), Guzzle\Http\Message\Response\isMethodAllowed(), Guzzle\Http\Message\AbstractMessage\removeCacheControlDirective(), and Guzzle\Http\Message\Request\removeCookie().

getHeaderLines()

Guzzle\Http\Message\AbstractMessage::getHeaderLines

(

)

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

Returns

array

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 105 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\$headers.

Referenced by Guzzle\Http\Message\Request\getRawHeaders(), and Guzzle\Http\Message\Response\getRawHeaders().

getHeaders()

Guzzle\Http\Message\AbstractMessage::getHeaders

(

)

Get all headers as a collection

Returns

\Guzzle\Http\Message\Header\HeaderCollection

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 100 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\$headers.

getParams()

Guzzle\Http\Message\AbstractMessage::getParams

(

)

Get application and plugin specific parameters set on the message.

Returns

\Guzzle\Common\Collection

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 68 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\$params.

Referenced by Guzzle\Http\Message\EntityEnclosingRequest\configureRedirects().

getTokenizedHeader()

Guzzle\Http\Message\AbstractMessage::getTokenizedHeader	(		$header,
			$token = ';'
	)

Deprecated:

Use $message->getHeader()->parseParams() @codeCoverageIgnore

Definition at line 149 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), Guzzle\Http\Message\AbstractMessage\hasHeader(), and Guzzle\Common\Version\warn().

hasCacheControlDirective()

Guzzle\Http\Message\AbstractMessage::hasCacheControlDirective

(

$directive

)

Deprecated:

@codeCoverageIgnore

Definition at line 195 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), and Guzzle\Common\Version\warn().

hasHeader()

Guzzle\Http\Message\AbstractMessage::hasHeader

(

$header

)

Check if the specified header is present.

Parameters

string

$header

The header to check.

Returns

bool

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 133 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Request\addCookie(), Guzzle\Http\Message\AbstractMessage\getTokenizedHeader(), Guzzle\Plugin\Cache\DefaultRevalidation\handle304Response(), Guzzle\Http\Message\EntityEnclosingRequest\setBody(), and Guzzle\Http\Message\Request\setState().

removeCacheControlDirective()

Guzzle\Http\Message\AbstractMessage::removeCacheControlDirective

(

$directive

)

Deprecated:

@codeCoverageIgnore

Definition at line 226 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\getHeader(), and Guzzle\Common\Version\warn().

removeHeader()

Guzzle\Http\Message\AbstractMessage::removeHeader

(

$header

)

Remove a specific HTTP header.

Parameters

string

$header

HTTP header to remove.

Returns

self

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 138 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\EntityEnclosingRequest\processPostFields(), Guzzle\Http\Message\Request\setAuth(), Guzzle\Http\Message\EntityEnclosingRequest\setExpectHeaderCutoff(), and Guzzle\Http\Message\Request\setState().

setHeader()

Guzzle\Http\Message\AbstractMessage::setHeader	(		$header,
			$value
	)

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

Parameters

string	$header	Name of the header to set.
mixed	$value	Value to set.

Returns

self

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 115 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\addHeader().

Referenced by Guzzle\Http\Message\Request\__construct(), Guzzle\Http\Message\Request\addCookie(), Guzzle\Http\Message\EntityEnclosingRequest\processPostFields(), Guzzle\Http\Message\Request\setAuth(), Guzzle\Http\Message\EntityEnclosingRequest\setBody(), Guzzle\Http\Message\EntityEnclosingRequest\setExpectHeaderCutoff(), and Guzzle\Http\Message\EntityEnclosingRequest\setState().

setHeaderFactory()

Guzzle\Http\Message\AbstractMessage::setHeaderFactory

(

HeaderFactoryInterface

$factory

)

Set the header factory to use to create headers

Parameters

HeaderFactoryInterface

$factory

Returns

self

Definition at line 61 of file AbstractMessage.php.

setHeaders()

Guzzle\Http\Message\AbstractMessage::setHeaders

(

array

$headers

)

Overwrite all HTTP headers with the supplied array of headers

Parameters

array

$headers

Associative array of header data.

Returns

self

Implements Guzzle\Http\Message\MessageInterface.

Definition at line 123 of file AbstractMessage.php.

References Guzzle\Http\Message\AbstractMessage\$headers, and Guzzle\Http\Message\AbstractMessage\addHeader().

Referenced by Guzzle\Http\Message\Response\__construct().

setTokenizedHeader()

Guzzle\Http\Message\AbstractMessage::setTokenizedHeader	(		$header,
			$data,
			$token = ';'
	)

Deprecated:

@codeCoverageIgnore

Definition at line 171 of file AbstractMessage.php.

References Guzzle\Common\Version\warn().

Field Documentation

$headerFactory

HeaderFactoryInterface Guzzle\Http\Message\AbstractMessage::$headerFactory

protected

$headerFactory

Definition at line 27 of file AbstractMessage.php.

$headers

array Guzzle\Http\Message\AbstractMessage::$headers

protected

HTTP header collection

Definition at line 21 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Request\__clone(), Guzzle\Http\Message\EntityEnclosingRequest\__construct(), Guzzle\Http\Message\Request\__construct(), Guzzle\Http\Message\Response\__construct(), Guzzle\Http\Message\AbstractMessage\addHeaders(), Guzzle\Http\Message\AbstractMessage\getHeaderLines(), Guzzle\Http\Message\AbstractMessage\getHeaders(), Guzzle\Http\Message\Response\getRawHeaders(), and Guzzle\Http\Message\AbstractMessage\setHeaders().

$params

Collection Guzzle\Http\Message\AbstractMessage::$params

protected

Custom message parameters that are extendable by plugins

Definition at line 33 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Request\__clone(), and Guzzle\Http\Message\AbstractMessage\getParams().

$protocol

string Guzzle\Http\Message\AbstractMessage::$protocol = 'HTTP'

protected

Message protocol

Definition at line 39 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Response\getProtocol(), Guzzle\Http\Message\Response\setProtocol(), and Guzzle\Http\Message\Request\setProtocolVersion().

$protocolVersion

string Guzzle\Http\Message\AbstractMessage::$protocolVersion = '1.1'

protected

HTTP protocol version of the message

Definition at line 45 of file AbstractMessage.php.

Referenced by Guzzle\Http\Message\Response\getProtocolVersion(), Guzzle\Http\Message\Request\getProtocolVersion(), and Guzzle\Http\Message\Request\getRawHeaders().

---

The documentation for this class was generated from the following file:

• AbstractMessage.php