Http/Response/Stream.php

Show:

inherited

Classes
- \Zend_Http_Response_Stream

Table of Contents

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Http
Subpackage: Response
Version: $Id$

\Zend_Http_Response_Stream
jump to top

Package: Zend_Http\Response

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-2014 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?

Details

Type: boolean

resource $stream

Response as stream

Details

Type: resource

string $stream_name

The name of the file containing the stream

Will be empty if stream is not file-based.

Details

Type: string

Methods

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

Parameters

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

Throws

Exception	Description
\Zend_Http_Exception

__destruct() : void

fromStream(string $response_str, resource $stream) : \Zend_Http_Response_Stream

static

Create a new Zend_Http_Response_Stream object from a string

Parameters

Name	Type	Description
$response_str	string
$stream	resource

Returns

Type	Description
\Zend_Http_Response_Stream

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.

Returns

Type	Description
string

getCleanup() : boolean

Get the cleanup trigger

Returns

Type	Description
boolean

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.

Returns

Type	Description
string

getStream() : \resourse

Get the response as stream

Returns

Type	Description
\resourse

getStreamName() : string

Get file name associated with the stream

Returns

Type	Description
string

readStream() : string

Read stream content and return it as string

Function reads the remainder of the body from the stream and closes the stream.

Returns

Type	Description
string

setCleanup(bool $cleanup = true) : void

Set the cleanup trigger

Parameters

Name	Type	Description
$cleanup	bool	Set cleanup trigger

setStream(\resourse $stream) : \Zend_Http_Response_Stream

Set the response stream

Parameters

Name	Type	Description
$stream	\resourse

Returns

Type	Description
\Zend_Http_Response_Stream

setStreamName(string $stream_name) : \Zend_Http_Response_Stream

Set file name associated with the stream

Parameters

Name	Type	Description
$stream_name	string	Name to set

Returns

Type	Description
\Zend_Http_Response_Stream

Http/Response/Stream.php

\Zend_Http_Response_Streamjump to top

Properties

Methods

\Zend_Http_Response_Stream
jump to top