Public Member Functions
	__construct ($code, array $headers, $body=null, $version= '1.1', $message=null)
	HTTP response constructor.

	isError ()
	Check whether the response is an error.

	isSuccessful ()
	Check whether the response in successful.

	isRedirect ()
	Check whether the response is a redirection.

	getBody ()
	Get the response body as string.

	getRawBody ()
	Get the raw response body (as transfered "on wire") as string.

	getVersion ()
	Get the HTTP version of the response.

	getStatus ()
	Get the HTTP response status code.

	getMessage ()
	Return a message describing the HTTP response code (Eg.

	getHeaders ()
	Get the response headers.

	getHeader ($header)
	Get a specific header as string, or null if it is not set.

	getHeadersAsString ($status_line=true, $br="\n")
	Get all headers as string.

	asString ($br="\n")
	Get the entire response as string.

	__toString ()
	Implements magic __toString()

Static Public Member Functions
static	responseCodeAsText ($code=null, $http11=true)
	A convenience function that returns a text representation of HTTP response codes.

static	extractCode ($response_str)
	Extract the response code from a response string.

static	extractMessage ($response_str)
	Extract the HTTP message from a response.

static	extractVersion ($response_str)
	Extract the HTTP version from a response.

static	extractHeaders ($response_str)
	Extract the headers from a response string.

static	extractBody ($response_str)
	Extract the body from a response string.

static	decodeChunkedBody ($body)
	Decode a "chunked" transfer-encoded body and return the decoded text.

static	decodeGzip ($body)
	Decode a gzip encoded message (when Content-encoding = gzip)

static	decodeDeflate ($body)
	Decode a zlib deflated message (when Content-encoding = deflate)

static	fromString ($response_str)
	Create a new Zend_Http_Response object from a string.

Protected Attributes
	$version

	$code

	$message

	$headers = array()

	$body

Static Protected Attributes
static	$messages

Constructor & Destructor Documentation

__construct	(		$code,
		array	$headers,
			$body = `null`,
			$version = `'1.1'`,
			$message = `null`
	)

HTTP response constructor.

In most cases, you would use Zend_Http_Response::fromString to parse an HTTP response string and create a new Zend_Http_Response object.

NOTE: The constructor no longer accepts nulls or empty values for the code and headers and will throw an exception if the passed values do not form a valid HTTP responses.

If no message is passed, the message will be guessed according to the response code.

Parameters

int	$code	Response code (200, 404, ...)
array	$headers	Headers array
string	$body	Response body
string	$version	HTTP version
string	$message	Response code as text

Exceptions

Zend_Http_Exception

Member Function Documentation

__toString ( )

Implements magic __toString()

Returns: string

asString ( $br = "\n" )

Get the entire response as string.

Parameters

string $br Line breaks (eg. "\n", "\r\n", "<br />")

Returns: string

static decodeChunkedBody ( $body )

static

Decode a "chunked" transfer-encoded body and return the decoded text.

Parameters

string $body

Returns: string

static decodeDeflate ( $body )

static

Decode a zlib deflated message (when Content-encoding = deflate)

Currently requires PHP with zlib support

Parameters

string $body

Returns: string

Some servers (IIS ?) send a broken deflate response, without the RFC-required zlib header.

We try to detect the zlib header, and if it does not exsit we teat the body is plain DEFLATE content.

This method was adapted from PEAR HTTP_Request2 by (c) Alexey Borzov

http://framework.zend.com/issues/browse/ZF-6040

static decodeGzip ( $body )

static

Decode a gzip encoded message (when Content-encoding = gzip)

Currently requires PHP with zlib support

Parameters

string $body

Returns: string

static extractBody ( $response_str )

static

Extract the body from a response string.

Parameters

string $response_str

Returns: string

static extractCode ( $response_str )

static

Extract the response code from a response string.

Parameters

string $response_str

Returns: int

static extractHeaders ( $response_str )

static

Extract the headers from a response string.

Parameters

string $response_str

Returns: array

static extractMessage ( $response_str )

static

Extract the HTTP message from a response.

Parameters

string $response_str

Returns: string

static extractVersion ( $response_str )

static

Extract the HTTP version from a response.

Parameters

string $response_str

Returns: string

static fromString ( $response_str )

static

Create a new Zend_Http_Response object from a string.

Parameters

string $response_str

Returns: Zend_Http_Response

getBody ( )

Get the response body as string.

This method returns the body of the HTTP response (the content), as it should be in it's readable version - that is, after decoding it (if it was decoded), deflating it (if it was gzip compressed), etc.

If you want to get the raw body (as transfered on wire) use $this->getRawBody() instead.

Returns: string

getHeader ( $header )

Get a specific header as string, or null if it is not set.

Parameters

string$header

Returns: string|array|null

getHeaders ( )

Get the response headers.

Returns: array

getHeadersAsString	(	$status_line = `true`,
		$br = `"\n"`
	)

Get all headers as string.

Parameters

boolean	$status_line	Whether to return the first status line (IE "HTTP 200 OK")
string	$br	Line breaks (eg. "\n", "\r\n", "<br />")

Returns: string

getMessage ( )

Return a message describing the HTTP response code (Eg.

"OK", "Not Found", "Moved Permanently")

Returns: string

getRawBody ( )

Get the raw response body (as transfered "on wire") as string.

If the body is encoded (with Transfer-Encoding, not content-encoding - IE "chunked" body), gzip compressed, etc. it will not be decoded.

Returns: string

getStatus ( )

Get the HTTP response status code.

Returns: int

getVersion ( )

Get the HTTP version of the response.

Returns: string

isError ( )

Check whether the response is an error.

Returns: boolean

isRedirect ( )

Check whether the response is a redirection.

Returns: boolean

isSuccessful ( )

Check whether the response in successful.

Returns: boolean

static responseCodeAsText	(	$code = `null`,
		$http11 = `true`
	)

static

A convenience function that returns a text representation of HTTP response codes.

Returns 'Unknown' for unknown codes. Returns array of all codes, if $code is not specified.

Conforms to HTTP/1.1 as defined in RFC 2616 (except for 'Unknown') See http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10 for reference

Parameters

int	$code	HTTP response code
boolean	$http11	Use HTTP version 1.1

Returns: string

Member Data Documentation

$body

protected

$code

protected

$headers = array()

protected

$message

protected

$messages

staticprotected

$version

protected

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation