Class: Microsoft_Http_Response
Source Location: /Http/Response.php
Microsoft_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.
Author(s):
Copyright:
- Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
|
|
Class Details
Class Variables
Class Methods
static method decodeChunkedBody [line 560]
static string decodeChunkedBody(
string
$body)
|
|
Decode a "chunked" transfer-encoded body and return the decoded text
Tags:
Parameters:
static method decodeDeflate [line 620]
static string decodeDeflate(
string
$body)
|
|
Decode a zlib deflated message (when Content-encoding = deflate) Currently requires PHP with zlib support
Tags:
Parameters:
static method decodeGzip [line 600]
static string decodeGzip(
string
$body)
|
|
Decode a gzip encoded message (when Content-encoding = gzip) Currently requires PHP with zlib support
Tags:
Parameters:
static method extractBody [line 545]
static string extractBody(
string
$response_str)
|
|
Extract the body from a response string
Tags:
Parameters:
static method extractCode [line 442]
static int extractCode(
string
$response_str)
|
|
Extract the response code from a response string
Tags:
Parameters:
static method extractHeaders [line 493]
static array extractHeaders(
string
$response_str)
|
|
Extract the headers from a response string
Tags:
Parameters:
static method extractMessage [line 459]
static string extractMessage(
string
$response_str)
|
|
Extract the HTTP message from a response
Tags:
Parameters:
static method extractVersion [line 476]
static string extractVersion(
string
$response_str)
|
|
Extract the HTTP version from a response
Tags:
Parameters:
static method fromString [line 654]
Create a new Microsoft_Http_Response object from a string
Tags:
Parameters:
static method responseCodeAsText [line 422]
static string responseCodeAsText(
[int
$code = null], [boolean
$http11 = true])
|
|
A convenience function that returns a text representation of HTTP response codes. 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
Tags:
Parameters:
constructor __construct [line 151]
Microsoft_Http_Response __construct(
int
$code, array
$headers, [string
$body = null], [string
$version = '1.1'], [string
$message = null])
|
|
HTTP response constructor In most cases, you would use Microsoft_Http_Response::fromString to parse an HTTP response string and create a new Microsoft_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.
Tags:
Overridden in child classes as:
- Microsoft_Http_Response_Stream::__construct()
- HTTP response constructor
Parameters:
method asString [line 395]
string asString(
[string
$br = "\n"])
|
|
Get the entire response as string
Tags:
Parameters:
method getBody [line 251]
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.
Tags:
Overridden in child classes as:
- Microsoft_Http_Response_Stream::getBody()
- Get the response body as string
method getHeader [line 350]
string|array|null getHeader(
string$header
$header)
|
|
Get a specific header as string, or null if it is not set
Tags:
Parameters:
method getHeaders [line 339]
Get the response headers
Tags:
method getHeadersAsString [line 365]
string getHeadersAsString(
[boolean
$status_line = true], [string
$br = "\n"])
|
|
Get all headers as string
Tags:
Parameters:
method getMessage [line 329]
Return a message describing the HTTP response code (Eg. "OK", "Not Found", "Moved Permanently")
Tags:
method getRawBody [line 298]
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.
Tags:
Overridden in child classes as:
- Microsoft_Http_Response_Stream::getRawBody()
- Get the raw response body (as transfered "on wire") as string
method getStatus [line 318]
Get the HTTP response status code
Tags:
method getVersion [line 308]
Get the HTTP version of the response
Tags:
method isError [line 199]
Check whether the response is an error
Tags:
method isRedirect [line 229]
Check whether the response is a redirection
Tags:
method isSuccessful [line 214]
Check whether the response in successful
Tags:
method __toString [line 405]
Implements magic __toString()
Tags:
|
|