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

boolean
$_cleanup= ''
Should we clean up the stream file when this response is closed?

__construct(
int $code, array $headers, string $body
=
null, string $version
=
1.1, string $message
=
null
)
:
void
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.
Name | Type | Description |
---|---|---|
$code | int | Response code (200, 404, ...) |
$headers | array | Headers array |
$body | string | Response body |
$version | string | HTTP version |
$message | string | Response code as text |
Exception | Description |
---|---|
\Zend_Http_Exception |

__toString(
)
:
string
Implements magic __toString()
Inherited from: \Zend_Http_Response::__toString()Type | Description |
---|---|
string |

asString(
string $br
=
\n
)
:
string
Get the entire response as string
Inherited from: \Zend_Http_Response::asString()Name | Type | Description |
---|---|---|
$br | string | Line breaks (eg. "\n", "\r\n", " |
Type | Description |
---|---|
string |

decodeChunkedBody(
string $body
)
:
string
Decode a "chunked" transfer-encoded body and return the decoded text
Inherited from: \Zend_Http_Response::decodeChunkedBody()Name | Type | Description |
---|---|---|
$body | string |
Type | Description |
---|---|
string |

decodeDeflate(
string $body
)
:
string
Decode a zlib deflated message (when Content-encoding = deflate)
Inherited from: \Zend_Http_Response::decodeDeflate()Currently requires PHP with zlib support
Name | Type | Description |
---|---|---|
$body | string |
Type | Description |
---|---|
string |

decodeGzip(
string $body
)
:
string
Decode a gzip encoded message (when Content-encoding = gzip)
Inherited from: \Zend_Http_Response::decodeGzip()Currently requires PHP with zlib support
Name | Type | Description |
---|---|---|
$body | string |
Type | Description |
---|---|
string |

extractBody(
string $response_str
)
:
string
Name | Type | Description |
---|---|---|
$response_str | string |
Type | Description |
---|---|
string |

extractCode(
string $response_str
)
:
int
Extract the response code from a response string
Inherited from: \Zend_Http_Response::extractCode()Name | Type | Description |
---|---|---|
$response_str | string |
Type | Description |
---|---|
int |

extractHeaders(
string $response_str
)
:
array
Extract the headers from a response string
Inherited from: \Zend_Http_Response::extractHeaders()Name | Type | Description |
---|---|---|
$response_str | string |
Type | Description |
---|---|
array |

extractMessage(
string $response_str
)
:
string
Extract the HTTP message from a response
Inherited from: \Zend_Http_Response::extractMessage()Name | Type | Description |
---|---|---|
$response_str | string |
Type | Description |
---|---|
string |

extractVersion(
string $response_str
)
:
string
Extract the HTTP version from a response
Inherited from: \Zend_Http_Response::extractVersion()Name | Type | Description |
---|---|---|
$response_str | string |
Type | Description |
---|---|
string |

fromStream(
string $response_str, resource $stream
)
:
\Zend_Http_Response_Stream
Create a new Zend_Http_Response_Stream object from a string
Name | Type | Description |
---|---|---|
$response_str | string | |
$stream | resource |
Type | Description |
---|---|
\Zend_Http_Response_Stream |

fromString(
string $response_str
)
:
\Zend_Http_Response
Create a new Zend_Http_Response object from a string
Inherited from: \Zend_Http_Response::fromString()
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.
Type | Description |
---|---|
string |

getHeader(
$header
)
:
string|array|null
Get a specific header as string, or null if it is not set
Inherited from: \Zend_Http_Response::getHeader()Name | Type | Description |
---|---|---|
$header | string$header |
Type | Description |
---|---|
stringarraynull |

getHeaders(
)
:
array
Get the response headers
Inherited from: \Zend_Http_Response::getHeaders()Type | Description |
---|---|
array |

getHeadersAsString(
boolean $status_line
=
true, string $br
=
\n
)
:
string
Get all headers as string
Inherited from: \Zend_Http_Response::getHeadersAsString()Name | Type | Description |
---|---|---|
$status_line | boolean | Whether to return the first status line (IE "HTTP 200 OK") |
$br | string | Line breaks (eg. "\n", "\r\n", " |
Type | Description |
---|---|
string |

getMessage(
)
:
string
Return a message describing the HTTP response code (Eg. "OK", "Not Found", "Moved Permanently")
Inherited from: \Zend_Http_Response::getMessage()Type | Description |
---|---|
string |

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.
Type | Description |
---|---|
string |

getStatus(
)
:
int
Get the HTTP response status code
Inherited from: \Zend_Http_Response::getStatus()Type | Description |
---|---|
int |

getVersion(
)
:
string
Get the HTTP version of the response
Inherited from: \Zend_Http_Response::getVersion()Type | Description |
---|---|
string |

isError(
)
:
boolean
Check whether the response is an error
Inherited from: \Zend_Http_Response::isError()Type | Description |
---|---|
boolean |

isRedirect(
)
:
boolean
Check whether the response is a redirection
Inherited from: \Zend_Http_Response::isRedirect()Type | Description |
---|---|
boolean |

isSuccessful(
)
:
boolean
Check whether the response in successful
Inherited from: \Zend_Http_Response::isSuccessful()Type | Description |
---|---|
boolean |

readStream(
)
:
string
Read stream content and return it as string
Function reads the remainder of the body from the stream and closes the stream.
Type | Description |
---|---|
string |

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.
Inherited from: \Zend_Http_Response::responseCodeAsText()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
Name | Type | Description |
---|---|---|
$code | int | HTTP response code |
$http11 | boolean | Use HTTP version 1.1 |
Type | Description |
---|---|
string |

setCleanup(
bool $cleanup
=
true
)
:
void
Set the cleanup trigger
Name | Type | Description |
---|---|---|
$cleanup | bool | Set cleanup trigger |

setStream(
\resourse $stream
)
:
\Zend_Http_Response_Stream
Set the response stream
Name | Type | Description |
---|---|---|
$stream | \resourse |
Type | Description |
---|---|
\Zend_Http_Response_Stream |

setStreamName(
string $stream_name
)
:
\Zend_Http_Response_Stream
Set file name associated with the stream
Name | Type | Description |
---|---|---|
$stream_name | string | Name to set |
Type | Description |
---|---|
\Zend_Http_Response_Stream |