## Zend_Http_Response

Description

Zend_Http_Response represents an HTTP 1.0 / 1.1 response message. It includes easy access to all the response's different elemts, as well as some convenience methods for parsing and validating HTTP responses.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Http/Response.php (line 34)

Direct descendents

Class | Description
--- | ---
Zend_Http_Response_Stream | Zend_Http_Response represents an HTTP 1.0 / 1.1 response message. It includes easy access to all the response's different elemts, as well as some convenience methods for parsing and validating HTTP responses.

Variable Summary
static array $messages
string $body
int $code
array $headers
string $message
string $version
Method Summary
static string decodeChunkedBody (string $body)
static string decodeDeflate (string $body)
static string decodeGzip (string $body)
static string extractBody (string $response_str)
static int extractCode (string $response_str)
static array extractHeaders (string $response_str)
static string extractMessage (string $response_str)
static string extractVersion (string $response_str)
static Zend_Http_Response fromString (string $response_str)
static string responseCodeAsText ([int $code = null], [boolean $http11 = true])
Zend_Http_Response __construct (int $code, $headers, [string $body = null], [string $version = '1.1'], [string $message = null])
string asString ([string $br = "\n"])
string getBody ()
string|array|null getHeader (string$header $header)
array getHeaders ()
string getHeadersAsString ([boolean $status_line = true], [string $br = "\n"])
string getMessage ()
string getRawBody ()
int getStatus ()
string getVersion ()
boolean isError ()
boolean isRedirect ()
boolean isSuccessful ()
string __toString ()
Variables
static array $messages = array(
// Informational 1xx
100 => 'Continue',
101 => 'Switching Protocols',
// Success 2xx
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
// Redirection 3xx
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found', // 1.1
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
// 306 is deprecated but reserved
307 => 'Temporary Redirect',
// Client Error 4xx
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Request Entity Too Large',
414 => 'Request-URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Requested Range Not Satisfiable',
417 => 'Expectation Failed',
// Server Error 5xx
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported',
509 => 'Bandwidth Limit Exceeded'
) (line 42)

List of all known HTTP response codes - used by responseCodeAsText() to translate numeric codes to messages.

- access: protected

string $body (line 130)

The HTTP response body

- access: protected

int $code (line 108)

The HTTP response code

- access: protected

array $headers = array() (line 123)

The HTTP response headers array

- access: protected

string $message (line 116)

The HTTP response code as string (e.g. 'Not Found' for 404 or 'Internal Server Error' for 500)

- access: protected

string $version (line 101)

The HTTP version (1.0, 1.1)

- access: protected

Methods
static decodeChunkedBody (line 563)

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

- access: public

static string decodeChunkedBody (string $body)

- string $body

static decodeDeflate (line 623)

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

Currently requires PHP with zlib support

- access: public

static string decodeDeflate (string $body)

- string $body

static decodeGzip (line 603)

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

Currently requires PHP with zlib support

- access: public

static string decodeGzip (string $body)

- string $body

static extractBody (line 548)

Extract the body from a response string

- access: public

static string extractBody (string $response_str)

- string $response_str

static extractCode (line 444)

Extract the response code from a response string

- access: public

static int extractCode (string $response_str)

- string $response_str

static extractHeaders (line 495)

Extract the headers from a response string

- access: public

static array extractHeaders (string $response_str)

- string $response_str

static extractMessage (line 461)

Extract the HTTP message from a response

- access: public

static string extractMessage (string $response_str)

- string $response_str

static extractVersion (line 478)

Extract the HTTP version from a response

- access: public

static string extractVersion (string $response_str)

- string $response_str

static fromString (line 657)

Create a new Zend_Http_Response object from a string

- access: public

static Zend_Http_Response fromString (string $response_str)

- string $response_str

static responseCodeAsText (line 424)

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

- access: public

static string responseCodeAsText ([int $code = null], [boolean $http11 = true])

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

Constructor __construct (line 151)

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.

- throws: Zend_Http_Exception
- access: public

Zend_Http_Response __construct (int $code, $headers, [string $body = null], [string $version = '1.1'], [string $message = null])

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

Redefined in descendants as:

- Zend_Http_Response_Stream::__construct() : HTTP response constructor

asString (line 397)

Get the entire response as string

- access: public

string asString ([string $br = "\n"])

- string $br: Line breaks (eg. "\n", "\r\n", "
  ")

getBody (line 253)

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.

- access: public

string getBody ()

Redefined in descendants as:

- Zend_Http_Response_Stream::getBody() : Get the response body as string

getHeader (line 352)

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

- access: public

string|array|null getHeader (string$header $header)

- string$header $header

getHeaders (line 341)

Get the response headers

- access: public

array getHeaders ()
getHeadersAsString (line 367)

Get all headers as string

- access: public

string getHeadersAsString ([boolean $status_line = true], [string $br = "\n"])

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

getMessage (line 331)

Return a message describing the HTTP response code (Eg. "OK", "Not Found", "Moved Permanently")

- access: public

string getMessage ()
getRawBody (line 300)

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.

- access: public

string getRawBody ()

Redefined in descendants as:

- Zend_Http_Response_Stream::getRawBody() : Get the raw response body (as transfered "on wire") as string

getStatus (line 320)

Get the HTTP response status code

- access: public

int getStatus ()
getVersion (line 310)

Get the HTTP version of the response

- access: public

string getVersion ()
isError (line 201)

Check whether the response is an error

- access: public

boolean isError ()
isRedirect (line 231)

Check whether the response is a redirection

- access: public

boolean isRedirect ()
isSuccessful (line 216)

Check whether the response in successful

- access: public

boolean isSuccessful ()
__toString (line 407)

Implements magic __toString()

- access: public

string __toString ()

Documentation generated on Tue, 26 Oct 2010 20:09:11 +0400 by phpDocumentor 1.4.2