Zend/Http/Response/Stream.php
Show:
inherited
inherited
Classes
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.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Http
- Subpackage
- Response
- Version
- $Id: Stream.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Http_Response_Stream
Package: Zend\Http\Response
Details
Details
Details
Parameters
Throws
Parameters
Returns
Returns
Returns
Returns
Returns
Returns
Returns
Parameters
Parameters
Returns
Parameters
Returns
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.
- Parent(s)
- \Zend_Http_Response
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean
$_cleanup= ''
Should we clean up the stream file when this response is closed?
- Type
- boolean
resource
$stream= ''
Response as stream
- Type
- resource
string
$stream_name= ''
The name of the file containing the stream
Will be empty if stream is not file-based.
- Type
- string
Methods
__construct(
int $code, array $headers, string $body
=
null, string $version
=
'1.1', string $message
=
null
)
:
voidHTTP 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 |
__destruct(
)
:
voidfromStream(
string $response_str, resource $stream
)
:
\Zend_Http_Response_Stream
static
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 |
getBody(
)
:
stringGet 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 |
getCleanup(
)
:
booleanGet the cleanup trigger
| Type | Description |
|---|---|
| boolean |
getRawBody(
)
:
stringGet 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 |
getStream(
)
:
\resourseGet the response as stream
| Type | Description |
|---|---|
| \resourse |
getStreamName(
)
:
stringGet file name associated with the stream
| Type | Description |
|---|---|
| string |
readStream(
)
:
stringRead stream content and return it as string
Function reads the remainder of the body from the stream and closes the stream.
| Type | Description |
|---|---|
| string |
setCleanup(
bool $cleanup
=
true
)
:
voidSet the cleanup trigger
| Name | Type | Description |
|---|---|---|
| $cleanup | bool | Set cleanup trigger |
setStream(
\resourse $stream
)
:
\Zend_Http_Response_StreamSet the response stream
| Name | Type | Description |
|---|---|---|
| $stream | \resourse |
| Type | Description |
|---|---|
| \Zend_Http_Response_Stream |
setStreamName(
string $stream_name
)
:
\Zend_Http_Response_StreamSet file name associated with the stream
| Name | Type | Description |
|---|---|---|
| $stream_name | string | Name to set |
| Type | Description |
|---|---|
| \Zend_Http_Response_Stream |