[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Http/Response/ -> Stream.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 235 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Http_Response_Stream:: (12 methods):
  getStream()
  setStream()
  getCleanup()
  setCleanup()
  getStreamName()
  setStreamName()
  __construct()
  fromStream()
  getBody()
  getRawBody()
  readStream()
  __destruct()


Class: Zend_Http_Response_Stream  - X-Ref

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.

getStream()   X-Ref
Get the response as stream

return: resourse

setStream($stream)   X-Ref
Set the response stream

param: resourse $stream
return: Zend_Http_Response_Stream

getCleanup()   X-Ref
Get the cleanup trigger

return: boolean

setCleanup($cleanup = true)   X-Ref
Set the cleanup trigger

param: $cleanup Set cleanup trigger

getStreamName()   X-Ref
Get file name associated with the stream

return: string

setStreamName($stream_name)   X-Ref
Set file name associated with the stream

param: string $stream_name Name to set
return: Zend_Http_Response_Stream

__construct($code, $headers, $body = null, $version = '1.1', $message = null)   X-Ref
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.

param: int $code Response code (200, 404, ...)
param: array $headers Headers array
param: string $body Response body
param: string $version HTTP version
param: string $message Response code as text

fromStream($response_str, $stream)   X-Ref
Create a new Zend_Http_Response_Stream object from a string

param: string $response_str
param: resource $stream
return: Zend_Http_Response_Stream

getBody()   X-Ref
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.

return: string

getRawBody()   X-Ref
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.

return: string

readStream()   X-Ref
Read stream content and return it as string

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

return: string

__destruct()   X-Ref
No description



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1