Http/Response/Stream.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: Stream.php 23775 2011-03-01 17:25:24Z ralph $
Classes: Zend_Http_Response_Stream

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_Stream
jump to top

Extends from: Zend_Http_Response
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: $stream; $stream_name; $_cleanup
Methods: getStream; setStream; getCleanup; setCleanup; getStreamName; setStreamName; __construct; fromStream; getBody; getRawBody; readStream; __destruct

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

$_cleanup
jump to class

boolean $_cleanup = ''

Should we clean up the stream file when this response is closed?

Details

$_cleanup: boolean
visibility: protected
default
final: false
static: false

$stream
jump to class

resource $stream = ''

Response as stream

Details

$stream: resource
visibility: protected
default
final: false
static: false

$stream_name
jump to class

string $stream_name = ''

The name of the file containing the stream

Will be empty if stream is not file-based.

Details

$stream_name: 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

__destruct
jump to class

__destruct(
          
          )
        
        :

Details

visibility: public
final: false
static: false

fromStream
jump to class

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

Create a new Zend_Http_Response_Stream object from a string

Arguments

$response_str: string
$stream: resource

Output

Zend_Http_Response_Stream

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

getCleanup
jump to class

getCleanup(
          
          )
        
        :
        boolean

Get the cleanup trigger

Output

boolean

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

getStream
jump to class

getStream(
          
          )
        
        :
        resourse

Get the response as stream

Output

resourse

Details

visibility: public
final: false
static: false

getStreamName
jump to class

getStreamName(
          
          )
        
        :
        string

Get file name associated with the stream

Output

string

Details

visibility: public
final: false
static: false

readStream
jump to class

readStream(
          
          )
        
        :
        string

Read stream content and return it as string

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

Output

string

Details

visibility: protected
final: false
static: false

setCleanup
jump to class

setCleanup(
          bool $cleanup
              =
              true
          )
        
        :

Set the cleanup trigger

Arguments

$cleanup: bool
Set cleanup trigger

Details

visibility: public
final: false
static: false

setStream
jump to class

setStream(
          resourse $stream
          )
        
        :
        Zend_Http_Response_Stream

Set the response stream

Arguments

$stream: resourse

Output

Zend_Http_Response_Stream

Details

visibility: public
final: false
static: false

setStreamName
jump to class

setStreamName(
          string $stream_name
          )
        
        :
        Zend_Http_Response_Stream

Set file name associated with the stream

Arguments

$stream_name: string
Name to set

Output

Zend_Http_Response_Stream

Details

visibility: public
final: false
static: false

API Documentation

Http/Response/Stream.php

Description

Zend_Http_Response_Streamjump to top

Description

Properties

$_cleanupjump to class

Details

$streamjump to class

Details

$stream_namejump to class

Details

Methods

__constructjump to class

Arguments

Details

__destructjump to class

Details

fromStreamjump to class

Arguments

Output

Details

getBodyjump to class

Output

Details

getCleanupjump to class

Output

Details

getRawBodyjump to class

Output

Details

getStreamjump to class

Output

Details

getStreamNamejump to class

Output

Details

readStreamjump to class

Output

Details

setCleanupjump to class

Arguments

Details

setStreamjump to class

Arguments

Output

Details

setStreamNamejump to class

Arguments

Output

Details

Zend_Http_Response_Stream
jump to top

$_cleanup
jump to class

$stream
jump to class

$stream_name
jump to class

__construct
jump to class

__destruct
jump to class

fromStream
jump to class

getBody
jump to class

getCleanup
jump to class

getRawBody
jump to class

getStream
jump to class

getStreamName
jump to class

readStream
jump to class

setCleanup
jump to class

setStream
jump to class

setStreamName
jump to class