\Guzzle\Http\MessageResponse

__construct()

__construct(string  $statusCode, \Guzzle\Common\ToArrayInterface|array  $headers = null, string|resource|\Guzzle\Http\EntityBodyInterface  $body = null) 

Construct the response

Parameters

Throws

\Guzzle\Http\Exception\BadResponseException

if an invalid response code is given

setHeaderFactory()

setHeaderFactory(\Guzzle\Http\Message\Header\HeaderFactoryInterface  $factory) : self

Set the header factory to use to create headers

Parameters

Returns

getParams()

getParams() : \Guzzle\Common\Collection

Get application and plugin specific parameters set on the message.

Returns

addHeader()

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

Add a header to an existing collection of headers.

Parameters

Returns

addHeaders()

addHeaders(array  $headers) : self

Add and merge in an array of HTTP headers.

Parameters

Returns

getHeader()

getHeader(string  $header) : \Guzzle\Http\Message\Header|null

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

Parameters

Returns

getHeaders()

getHeaders() : \Guzzle\Http\Message\Header\HeaderCollection

Get all headers as a collection

Returns

getHeaderLines()

getHeaderLines() : array

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

..])

Returns

setHeader()

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

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

Parameters

Returns

setHeaders()

setHeaders(array  $headers) : self

Overwrite all HTTP headers with the supplied array of headers

Parameters

Returns

hasHeader()

hasHeader(string  $header) : boolean

Check if the specified header is present.

Parameters

Returns

removeHeader()

removeHeader(string  $header) : self

Remove a specific HTTP header.

Parameters

Returns

getTokenizedHeader()

getTokenizedHeader(  $header,   $token = ';') 

Parameters

setTokenizedHeader()

setTokenizedHeader(  $header,   $data,   $token = ';') 

Parameters

getCacheControlDirective()

getCacheControlDirective(  $directive) 

Parameters

hasCacheControlDirective()

hasCacheControlDirective(  $directive) 

Parameters

addCacheControlDirective()

addCacheControlDirective(  $directive,   $value = true) 

Parameters

removeCacheControlDirective()

removeCacheControlDirective(  $directive) 

Parameters

fromMessage()

fromMessage(string  $message) : self|boolean

Create a new Response based on a raw response message

Parameters

Returns

Returns false on error

__toString()

__toString() : string

Returns

serialize()

serialize() 

unserialize()

unserialize(  $serialize) 

Parameters

getBody()

getBody(boolean  $asString = false) : \Guzzle\Http\EntityBodyInterface|string

Get the response entity body

Parameters

Returns

setBody()

setBody(\Guzzle\Http\EntityBodyInterface|string  $body) : self

Set the response entity body

Parameters

Returns

setProtocol()

setProtocol(string  $protocol, string  $version) : self

Set the protocol and protocol version of the response

Parameters

Returns

getProtocol()

getProtocol() : string

Get the protocol used for the response (e.g. HTTP)

Returns

getProtocolVersion()

getProtocolVersion() : string

Get the HTTP protocol version

Returns

getInfo()

getInfo(string  $key = null) : array|string|null

Get a cURL transfer information

Parameters

Returns

Returns all stats if no key is set, a single stat if a key is set, or null if a key is set and not found

setInfo()

setInfo(array  $info) : self

Set the transfer information

Parameters

Returns

setStatus()

setStatus(integer  $statusCode, string  $reasonPhrase = '') : self

Set the response status

Parameters

Throws

\Guzzle\Http\Exception\BadResponseException

when an invalid response code is received

Returns

getStatusCode()

getStatusCode() : integer

Get the response status code

Returns

getMessage()

getMessage() : string

Get the entire response as a string

Returns

getRawHeaders()

getRawHeaders() : string

Get the the raw message headers as a string

Returns

getReasonPhrase()

getReasonPhrase() : string

Get the response reason phrase- a human readable version of the numeric status code

Returns

getAcceptRanges()

getAcceptRanges() : string

Get the Accept-Ranges HTTP header

Returns

Returns what partial content range types this server supports.

calculateAge()

calculateAge() : integer

Calculate the age of the response

Returns

getAge()

getAge() : integer|null

Get the Age HTTP header

Returns

Returns the age the object has been in a proxy cache in seconds.

getAllow()

getAllow() : string|null

Get the Allow HTTP header

Returns

Returns valid actions for a specified resource. To be used for a 405 Method not allowed.

isMethodAllowed()

isMethodAllowed(string  $method) : boolean

Check if an HTTP method is allowed by checking the Allow response header

Parameters

Returns

getCacheControl()

getCacheControl() : string

Get the Cache-Control HTTP header

Returns

getConnection()

getConnection() : string

Get the Connection HTTP header

Returns

getContentEncoding()

getContentEncoding() : string|null

Get the Content-Encoding HTTP header

Returns

getContentLanguage()

getContentLanguage() : string|null

Get the Content-Language HTTP header

Returns

Returns the language the content is in.

getContentLength()

getContentLength() : integer

Get the Content-Length HTTP header

Returns

Returns the length of the response body in bytes

getContentLocation()

getContentLocation() : string|null

Get the Content-Location HTTP header

Returns

Returns an alternate location for the returned data (e.g /index.htm)

getContentDisposition()

getContentDisposition() : string|null

Get the Content-Disposition HTTP header

Returns

Returns the Content-Disposition header

getContentMd5()

getContentMd5() : string|null

Get the Content-MD5 HTTP header

Returns

Returns a Base64-encoded binary MD5 sum of the content of the response.

getContentRange()

getContentRange() : string

Get the Content-Range HTTP header

Returns

Returns where in a full body message this partial message belongs (e.g. bytes 21010-47021/47022).

getContentType()

getContentType() : string

Get the Content-Type HTTP header

Returns

Returns the mime type of this content.

isContentType()

isContentType(string  $type) : boolean

Checks if the Content-Type is of a certain type. This is useful if the Content-Type header contains charset information and you need to know if the Content-Type matches a particular type.

Parameters

Returns

getDate()

getDate() : string|null

Get the Date HTTP header

Returns

Returns the date and time that the message was sent.

getEtag()

getEtag() : string|null

Get the ETag HTTP header

Returns

Returns an identifier for a specific version of a resource, often a Message digest.

getExpires()

getExpires() : string|null

Get the Expires HTTP header

Returns

Returns the date/time after which the response is considered stale.

getLastModified()

getLastModified() : string|null

Get the Last-Modified HTTP header

Returns

Returns the last modified date for the requested object, in RFC 2822 format (e.g. Tue, 15 Nov 1994 12:45:26 GMT)

getLocation()

getLocation() : string|null

Get the Location HTTP header

Returns

Used in redirection, or when a new resource has been created.

getPragma()

getPragma() : \Guzzle\Http\Message\Header|null

Get the Pragma HTTP header

Returns

Returns the implementation-specific headers that may have various effects anywhere along the request-response chain.

getProxyAuthenticate()

getProxyAuthenticate() : string|null

Get the Proxy-Authenticate HTTP header

Returns

Authentication to access the proxy (e.g. Basic)

getRetryAfter()

getRetryAfter() : integer|null

Get the Retry-After HTTP header

Returns

If an entity is temporarily unavailable, this instructs the client to try again after a specified period of time.

getServer()

getServer() : string|null

Get the Server HTTP header

Returns

A name for the server

getSetCookie()

getSetCookie() : string|null

Get the Set-Cookie HTTP header

Returns

An HTTP cookie.

getTrailer()

getTrailer() : string|null

Get the Trailer HTTP header

Returns

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer-coding.

getTransferEncoding()

getTransferEncoding() : string|null

Get the Transfer-Encoding HTTP header

Returns

The form of encoding used to safely transfer the entity to the user

getVary()

getVary() : string|null

Get the Vary HTTP header

Returns

Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server.

getVia()

getVia() : string|null

Get the Via HTTP header

Returns

Informs the client of proxies through which the response was sent.

getWarning()

getWarning() : string|null

Get the Warning HTTP header

Returns

A general warning about possible problems with the entity body

getWwwAuthenticate()

getWwwAuthenticate() : string|null

Get the WWW-Authenticate HTTP header

Returns

Indicates the authentication scheme that should be used to access the requested entity

isClientError()

isClientError() : boolean

Checks if HTTP Status code is a Client Error (4xx)

Returns

isError()

isError() : boolean

Checks if HTTP Status code is Server OR Client Error (4xx or 5xx)

Returns

isInformational()

isInformational() : boolean

Checks if HTTP Status code is Information (1xx)

Returns

isRedirect()

isRedirect() : boolean

Checks if HTTP Status code is a Redirect (3xx)

Returns

isServerError()

isServerError() : boolean

Checks if HTTP Status code is Server Error (5xx)

Returns

isSuccessful()

isSuccessful() : boolean

Checks if HTTP Status code is Successful (2xx | 304)

Returns

canCache()

canCache() : boolean

Check if the response can be cached based on the response headers

Returns

Returns TRUE if the response can be cached or false if not

getMaxAge()

getMaxAge() : integer|null

Gets the number of seconds from the current time in which this response is still considered fresh

Returns

Returns the number of seconds

isFresh()

isFresh() : boolean|null

Check if the response is considered fresh.

A response is considered fresh when its age is less than or equal to the freshness lifetime (maximum age) of the response.

Returns

canValidate()

canValidate() : boolean

Check if the response can be validated against the origin server using a conditional GET request.

Returns

getFreshness()

getFreshness() : integer

Get the freshness of the response by returning the difference of the maximum lifetime of the response and the age of the response (max-age - age).

Freshness values less than 0 mean that the response is no longer fresh and is ABS(freshness) seconds expired. Freshness values of greater than zero is the number of seconds until the response is no longer fresh. A NULL result means that no freshness information is available.

Returns

json()

json() : array|string|integer|boolean|float

Parse the JSON response body and return an array

Throws

\Guzzle\Common\Exception\RuntimeException

if the response body is not in JSON format

Returns

xml()

xml() : \SimpleXMLElement

Parse the XML response body and return a \SimpleXMLElement.

In order to prevent XXE attacks, this method disables loading external entities. If you rely on external entities, then you must parse the XML response manually by accessing the response body directly.

Throws

\Guzzle\Common\Exception\RuntimeException

if the response body is not in XML format

Returns

getRedirectCount()

getRedirectCount() : integer

Get the redirect count of this response

Returns

setEffectiveUrl()

setEffectiveUrl(string  $url) : self

Set the effective URL that resulted in this response (e.g. the last redirect URL)

Parameters

Returns

getEffectiveUrl()

getEffectiveUrl() : string

Get the effective URL that resulted in this response (e.g. the last redirect URL)

Returns

getPreviousResponse()

getPreviousResponse() 

setRequest()

setRequest(  $request) 

Parameters

getRequest()

getRequest()