Class Response

Guzzle\Http\Message\AbstractMessage implements Guzzle\Http\Message\MessageInterface

Guzzle\Http\Message\Response implements Serializable

Methods summary

• public static fromMessage ( string $message )

  Create a new Response based on a raw response message

• public __construct ( string $statusCode, ToArrayInterface|array $headers = null, string|resource|EntityBodyInterface $body = null )

  Construct the response

• public __toString ( )
• public serialize ( )
• public unserialize ( mixed $serialize )
• public getBody ( bool $asString = false )

  Get the response entity body

• public setBody ( EntityBodyInterface|string $body )

  Set the response entity body

• public setProtocol ( string $protocol, string $version )

  Set the protocol and protocol version of the response

• public getProtocol ( )

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

• public getProtocolVersion ( )

  Get the HTTP protocol version

• public getInfo ( string $key = null )

  Get a cURL transfer information

• public setInfo ( array $info )

  Set the transfer information

• public setStatus ( int $statusCode, string $reasonPhrase = '' )

  Set the response status

• public getStatusCode ( )

  Get the response status code

• public getMessage ( )

  Get the entire response as a string

• public getRawHeaders ( )

  Get the the raw message headers as a string

• public getReasonPhrase ( )

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

• public getAcceptRanges ( )

  Get the Accept-Ranges HTTP header

• public calculateAge ( )

  Calculate the age of the response

• public getAge ( )

  Get the Age HTTP header

• public getAllow ( )

  Get the Allow HTTP header

• public isMethodAllowed ( string $method )

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

• public getCacheControl ( )

  Get the Cache-Control HTTP header

• public getConnection ( )

  Get the Connection HTTP header

• public getContentEncoding ( )

  Get the Content-Encoding HTTP header

• public getContentLanguage ( )

  Get the Content-Language HTTP header

• public getContentLength ( )

  Get the Content-Length HTTP header

• public getContentLocation ( )

  Get the Content-Location HTTP header

• public getContentDisposition ( )

  Get the Content-Disposition HTTP header

• public getContentMd5 ( )

  Get the Content-MD5 HTTP header

• public getContentRange ( )

  Get the Content-Range HTTP header

• public getContentType ( )

  Get the Content-Type HTTP header

• public isContentType ( string $type )

  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.

• public getDate ( )

  Get the Date HTTP header

• public getEtag ( )

  Get the ETag HTTP header

• public getExpires ( )

  Get the Expires HTTP header

• public getLastModified ( )

  Get the Last-Modified HTTP header

• public getLocation ( )

  Get the Location HTTP header

• public getPragma ( )

  Get the Pragma HTTP header

• public getProxyAuthenticate ( )

  Get the Proxy-Authenticate HTTP header

• public getRetryAfter ( )

  Get the Retry-After HTTP header

• public getServer ( )

  Get the Server HTTP header

• public getSetCookie ( )

  Get the Set-Cookie HTTP header

• public getTrailer ( )

  Get the Trailer HTTP header

• public getTransferEncoding ( )

  Get the Transfer-Encoding HTTP header

• public getVary ( )

  Get the Vary HTTP header

• public getVia ( )

  Get the Via HTTP header

• public getWarning ( )

  Get the Warning HTTP header

• public getWwwAuthenticate ( )

  Get the WWW-Authenticate HTTP header

• public isClientError ( )

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

• public isError ( )

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

• public isInformational ( )

  Checks if HTTP Status code is Information (1xx)

• public isRedirect ( )

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

• public isServerError ( )

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

• public isSuccessful ( )

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

• public canCache ( )

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

• public getMaxAge ( )

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

• public isFresh ( )

  Check if the response is considered fresh.

• public canValidate ( )

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

• public getFreshness ( )

  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).

• public json ( )

  Parse the JSON response body and return an array

• public xml ( )

  Parse the XML response body and return a \SimpleXMLElement.

• public getRedirectCount ( )

  Get the redirect count of this response

• public setEffectiveUrl ( string $url )

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

• public getEffectiveUrl ( )

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

Methods detail

Methods inherited from Guzzle\Http\Message\AbstractMessage

addHeader(), addHeaders(), getHeader(), getHeaderLines(), getHeaders(), getParams(), hasHeader(), removeHeader(), setHeader(), setHeaderFactory(), setHeaders()

Magic methods summary

Properties summary

Properties inherited from Guzzle\Http\Message\AbstractMessage

$headerFactory, $headers, $params, $protocol, $protocolVersion