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

Details

Type: boolean

string $body

inherited

The HTTP response body

Inherited from: \Zend_Http_Response::$$body

Details

Type: string
Inherited_from: \Zend_Http_Response::$$body

int $code

inherited

The HTTP response code

Inherited from: \Zend_Http_Response::$$code

Details

Type: int
Inherited_from: \Zend_Http_Response::$$code

array $headers = array()

inherited

The HTTP response headers array

Inherited from: \Zend_Http_Response::$$headers

Default valuearray()Details

Type: array
Inherited_from: \Zend_Http_Response::$$headers

string $message

inherited

The HTTP response code as string (e.g.

Inherited from: \Zend_Http_Response::$$message

'Not Found' for 404 or 'Internal Server Error' for 500)

Details

Type: string
Inherited_from: \Zend_Http_Response::$$message

array $messages = array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 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', 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')

staticinherited

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

Inherited from: \Zend_Http_Response::$$messages

Default value

array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 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', 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')

Details

Type: array
Inherited_from: \Zend_Http_Response::$$messages

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

string $version

inherited

The HTTP version (1.0, 1.1)

Inherited from: \Zend_Http_Response::$$version

Details

Type: string
Inherited_from: \Zend_Http_Response::$$version

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

__toString() : string

inherited

Implements magic __toString()

Inherited from: \Zend_Http_Response::__toString()

Returns

Type	Description
string

asString(string $br = "\n") : string

inherited

Get the entire response as string

Inherited from: \Zend_Http_Response::asString()

Parameters

Name	Type	Description
$br	string	Line breaks (eg. "\n", "\r\n", " ")

Returns

Type	Description
string

decodeChunkedBody(string $body) : string

staticinherited

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

Inherited from: \Zend_Http_Response::decodeChunkedBody()

Parameters

Name	Type	Description
$body	string

Returns

Type	Description
string

decodeDeflate(string $body) : string

staticinherited

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

Inherited from: \Zend_Http_Response::decodeDeflate()

Currently requires PHP with zlib support

Parameters

Name	Type	Description
$body	string

Returns

Type	Description
string

decodeGzip(string $body) : string

staticinherited

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

Inherited from: \Zend_Http_Response::decodeGzip()

Currently requires PHP with zlib support

Parameters

Name	Type	Description
$body	string

Returns

Type	Description
string

extractBody(string $response_str) : string

staticinherited

Extract the body from a response string

Inherited from: \Zend_Http_Response::extractBody()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
string

extractCode(string $response_str) : int

staticinherited

Extract the response code from a response string

Inherited from: \Zend_Http_Response::extractCode()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
int

extractHeaders(string $response_str) : array

staticinherited

Extract the headers from a response string

Inherited from: \Zend_Http_Response::extractHeaders()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
array

extractMessage(string $response_str) : string

staticinherited

Extract the HTTP message from a response

Inherited from: \Zend_Http_Response::extractMessage()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
string

extractVersion(string $response_str) : string

staticinherited

Extract the HTTP version from a response

Inherited from: \Zend_Http_Response::extractVersion()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
string

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

fromString(string $response_str) : \Zend_Http_Response

staticinherited

Create a new Zend_Http_Response object from a string

Inherited from: \Zend_Http_Response::fromString()

Parameters

Name	Type	Description
$response_str	string

Returns

Type	Description
\Zend_Http_Response

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

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

inherited

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

Inherited from: \Zend_Http_Response::getHeader()

Parameters

Name	Type	Description
$header	\string$header

Returns

Type	Description
string \| array \| null

getHeaders() : array

inherited

Get the response headers

Inherited from: \Zend_Http_Response::getHeaders()

Returns

Type	Description
array

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

inherited

Get all headers as string

Inherited from: \Zend_Http_Response::getHeadersAsString()

Parameters

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", " ")

Returns

Type	Description
string

getMessage() : string

inherited

Return a message describing the HTTP response code (Eg.

Inherited from: \Zend_Http_Response::getMessage()

"OK", "Not Found", "Moved Permanently")

Returns

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.

Returns

Type	Description
string

getStatus() : int

inherited

Get the HTTP response status code

Inherited from: \Zend_Http_Response::getStatus()

Returns

Type	Description
int

getStream() : \resourse

Get the response as stream

Returns

Type	Description
\resourse

getStreamName() : string

Get file name associated with the stream

Returns

Type	Description
string

getVersion() : string

inherited

Get the HTTP version of the response

Inherited from: \Zend_Http_Response::getVersion()

Returns

Type	Description
string

isError() : boolean

inherited

Check whether the response is an error

Inherited from: \Zend_Http_Response::isError()

Returns

Type	Description
boolean

isRedirect() : boolean

inherited

Check whether the response is a redirection

Inherited from: \Zend_Http_Response::isRedirect()

Returns

Type	Description
boolean

isSuccessful() : boolean

inherited

Check whether the response in successful

Inherited from: \Zend_Http_Response::isSuccessful()

Returns

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.

Returns

Type	Description
string

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

staticinherited

A convenience function that returns a text representation of HTTP response codes.

Inherited from: \Zend_Http_Response::responseCodeAsText()

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

Parameters

Name	Type	Description
$code	int	HTTP response code
$http11	boolean	Use HTTP version 1.1

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