Http/Response.php

category: Zend
copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Http
subpackage: Response
version: $Id: Response.php 23775 2011-03-01 17:25:24Z ralph $
Classes: Zend_Http_Response

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Http_Response
jump to top

copyright: Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Http
subpackage: Response
Properties: $messages; $version; $code; $message; $headers; $body
Methods: __construct; isError; isSuccessful; isRedirect; getBody; getRawBody; getVersion; getStatus; getMessage; getHeaders; getHeader; getHeadersAsString; asString; __toString; responseCodeAsText; extractCode; extractMessage; extractVersion; extractHeaders; extractBody; decodeChunkedBody; decodeGzip; decodeDeflate; fromString

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.

Properties

$body
jump to class

string $body = ''

The HTTP response body

Details

$body: string
visibility: protected
default
final: false
static: false

$code
jump to class

int $code = ''

The HTTP response code

Details

$code: int
visibility: protected
default
final: false
static: false

$headers
jump to class

array $headers = 'array'

The HTTP response headers array

Details

$headers: array
visibility: protected
default: array
final: false
static: false

$message
jump to class

string $message = ''

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

Details

$message: string
visibility: protected
default
final: false
static: false

$messages
jump to class

array $messages = 'array'

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

Details

$messages: array
visibility: protected
default: array
final: false
static: true

$version
jump to class

string $version = ''

The HTTP version (1.0, 1.1)

Details

$version: string
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          int $code, array $headers, string $body
              =
              null, string $version
              =
              1.1, string $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.

Arguments

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

Details

visibility: public
final: false
static: false
throws

__toString
jump to class

__toString(
          
          )
        
        :
        string

Implements magic __toString()

Output

string

Details

visibility: public
final: false
static: false

asString
jump to class

asString(
          string $br
              =
              \n
          )
        
        :
        string

Get the entire response as string

Arguments

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

Output

string

Details

visibility: public
final: false
static: false

decodeChunkedBody
jump to class

decodeChunkedBody(
          string $body
          )
        
        :
        string

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

Arguments

$body: string

Output

string

Details

visibility: public
final: false
static: true

decodeDeflate
jump to class

decodeDeflate(
          string $body
          )
        
        :
        string

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

Currently requires PHP with zlib support

Arguments

$body: string

Output

string

Details

visibility: public
final: false
static: true

decodeGzip
jump to class

decodeGzip(
          string $body
          )
        
        :
        string

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

Currently requires PHP with zlib support

Arguments

$body: string

Output

string

Details

visibility: public
final: false
static: true

extractBody
jump to class

extractBody(
          string $response_str
          )
        
        :
        string

Extract the body from a response string

Arguments

$response_str: string

Output

string

Details

visibility: public
final: false
static: true

extractCode
jump to class

extractCode(
          string $response_str
          )
        
        :
        int

Extract the response code from a response string

Arguments

$response_str: string

Output

int

Details

visibility: public
final: false
static: true

extractHeaders
jump to class

extractHeaders(
          string $response_str
          )
        
        :
        array

Extract the headers from a response string

Arguments

$response_str: string

Output

array

Details

visibility: public
final: false
static: true

extractMessage
jump to class

extractMessage(
          string $response_str
          )
        
        :
        string

Extract the HTTP message from a response

Arguments

$response_str: string

Output

string

Details

visibility: public
final: false
static: true

extractVersion
jump to class

extractVersion(
          string $response_str
          )
        
        :
        string

Extract the HTTP version from a response

Arguments

$response_str: string

Output

string

Details

visibility: public
final: false
static: true

fromString
jump to class

fromString(
          string $response_str
          )
        
        :
        Zend_Http_Response

Create a new Zend_Http_Response object from a string

Arguments

$response_str: string

Output

Zend_Http_Response

Details

visibility: public
final: false
static: true

getBody
jump to class

getBody(
          
          )
        
        :
        string

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.

Output

string

Details

visibility: public
final: false
static: false

getHeader
jump to class

getHeader(
           $header
          )
        
        :
        string|array|null

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

Arguments

$header: string$header

Output

string|array|null

Details

visibility: public
final: false
static: false

getHeaders
jump to class

getHeaders(
          
          )
        
        :
        array

Get the response headers

Output

array

Details

visibility: public
final: false
static: false

getHeadersAsString
jump to class

getHeadersAsString(
          boolean $status_line
              =
              true, string $br
              =
              \n
          )
        
        :
        string

Get all headers as string

Arguments

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

Output

string

Details

visibility: public
final: false
static: false

getMessage
jump to class

getMessage(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

getRawBody
jump to class

getRawBody(
          
          )
        
        :
        string

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.

Output

string

Details

visibility: public
final: false
static: false

getStatus
jump to class

getStatus(
          
          )
        
        :
        int

Get the HTTP response status code

Output

int

Details

visibility: public
final: false
static: false

getVersion
jump to class

getVersion(
          
          )
        
        :
        string

Get the HTTP version of the response

Output

string

Details

visibility: public
final: false
static: false

isError
jump to class

isError(
          
          )
        
        :
        boolean

Check whether the response is an error

Output

boolean

Details

visibility: public
final: false
static: false

isRedirect
jump to class

isRedirect(
          
          )
        
        :
        boolean

Check whether the response is a redirection

Output

boolean

Details

visibility: public
final: false
static: false

isSuccessful
jump to class

isSuccessful(
          
          )
        
        :
        boolean

Check whether the response in successful

Output

boolean

Details

visibility: public
final: false
static: false

responseCodeAsText
jump to class

responseCodeAsText(
          int $code
              =
              null, boolean $http11
              =
              true
          )
        
        :
        string

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

Arguments

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

Output

string

Details

visibility: public
final: false
static: true

API Documentation

Http/Response.php

Description

Zend_Http_Responsejump to top

Description

Properties

$bodyjump to class

Details

$codejump to class

Details

$headersjump to class

Details

$messagejump to class

Details

$messagesjump to class

Details

$versionjump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

asStringjump to class

Arguments

Output

Details

decodeChunkedBodyjump to class

Arguments

Output

Details

decodeDeflatejump to class

Arguments

Output

Details

decodeGzipjump to class

Arguments

Output

Details

extractBodyjump to class

Arguments

Output

Details

extractCodejump to class

Arguments

Output

Details

extractHeadersjump to class

Arguments

Output

Details

extractMessagejump to class

Arguments

Output

Details

extractVersionjump to class

Arguments

Output

Details

fromStringjump to class

Arguments

Output

Details

getBodyjump to class

Output

Details

getHeaderjump to class

Arguments

Output

Details

getHeadersjump to class

Output

Details

getHeadersAsStringjump to class

Arguments

Output

Details

getMessagejump to class

Zend_Http_Response
jump to top

$body
jump to class

$code
jump to class

$headers
jump to class

$message
jump to class

$messages
jump to class

$version
jump to class

__construct
jump to class

__toString
jump to class

asString
jump to class

decodeChunkedBody
jump to class

decodeDeflate
jump to class

decodeGzip
jump to class

extractBody
jump to class

extractCode
jump to class

extractHeaders
jump to class

extractMessage
jump to class

extractVersion
jump to class

fromString
jump to class

getBody
jump to class

getHeader
jump to class

getHeaders
jump to class

getHeadersAsString
jump to class

getMessage
jump to class

getRawBody
jump to class

getStatus
jump to class

getVersion
jump to class

isError
jump to class

isRedirect
jump to class

isSuccessful
jump to class

responseCodeAsText
jump to class