Zend_Http_Response Class Reference

Inheritance diagram for Zend_Http_Response:

Public Member Functions
	__construct ($code, array $headers, $body=null, $version='1.1', $message=null)
	isError ()
	isSuccessful ()
	isRedirect ()
	getBody ()
	getRawBody ()
	getVersion ()
	getStatus ()
	getMessage ()
	getHeaders ()
	getHeader ($header)
	getHeadersAsString ($status_line=true, $br="\n")
	asString ($br="\r\n")
	__toString ()

Static Public Member Functions
static	responseCodeAsText ($code=null, $http11=true)
static	extractCode ($response_str)
static	extractMessage ($response_str)
static	extractVersion ($response_str)
static	extractHeaders ($response_str)
static	extractBody ($response_str)
static	decodeChunkedBody ($body)
static	decodeGzip ($body)
static	decodeDeflate ($body)
static	fromString ($response_str)

Protected Attributes
	$version
	$code
	$message
	$headers = array()
	$body

Static Protected Attributes
static	$messages

Detailed Description

Definition at line 39 of file Response.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

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

Exceptions

Zend_Http_Exception

Definition at line 156 of file Response.php.

    {
        // Make sure the response code is valid and set it
        if (self::responseCodeAsText($code) === null) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("{$code} is not a valid HTTP response code");
        }

        $this->code = $code;

        foreach ($headers as $name => $value) {
            if (is_int($name)) {
                $header = explode(":", $value, 2);
                if (count($header) != 2) {
                    #require_once 'Zend/Http/Exception.php';
                    throw new Zend_Http_Exception("'{$value}' is not a valid HTTP header");
                }

                $name  = trim($header[0]);
                $value = trim($header[1]);
            }

            $this->headers[ucwords(strtolower($name))] = $value;
        }

        // Set the body
        $this->body = $body;

        // Set the HTTP version
        if (! preg_match('|^\d\.\d$|', $version)) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception("Invalid HTTP response version: $version");
        }

        $this->version = $version;

        // If we got the response message, set it. Else, set it according to
        // the response code
        if (is_string($message)) {
            $this->message = $message;
        } else {
            $this->message = self::responseCodeAsText($code);
        }
    }

Member Function Documentation

__toString()

__toString

(

)

Implements magic __toString()

Returns

string

Definition at line 412 of file Response.php.

    {
        return $this->asString();
    }

asString()

asString

(

$br = "\r\n"

)

Get the entire response as string

Parameters

string

$br

Line breaks (eg. "\n", "\r\n", "<br />")

Returns

string

Definition at line 402 of file Response.php.

    {
        return $this->getHeadersAsString(true, $br) . $br . $this->getRawBody();
    }

decodeChunkedBody()

static decodeChunkedBody (   $body )

static

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

Parameters

string

$body

Returns

string

Definition at line 599 of file Response.php.

    {
        $decBody = '';

        // If mbstring overloads substr and strlen functions, we have to
        // override it's internal encoding
        if (function_exists('mb_internal_encoding') &&
           ((int) ini_get('mbstring.func_overload')) & 2) {

            $mbIntEnc = mb_internal_encoding();
            mb_internal_encoding('ASCII');
        }

        while (trim($body)) {
            if (! preg_match("/^([\da-fA-F]+)[^\r\n]*\r\n/sm", $body, $m)) {
                #require_once 'Zend/Http/Exception.php';
                throw new Zend_Http_Exception("Error parsing body - doesn't seem to be a chunked message");
            }

            $length = hexdec(trim($m[1]));
            $cut = strlen($m[0]);
            $decBody .= substr($body, $cut, $length);
            $body = substr($body, $cut + $length + 2);
        }

        if (isset($mbIntEnc)) {
            mb_internal_encoding($mbIntEnc);
        }

        return $decBody;
    }

decodeDeflate()

static decodeDeflate (   $body )

static

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

Currently requires PHP with zlib support

Parameters

string

$body

Returns

string

Some servers (IIS ?) send a broken deflate response, without the RFC-required zlib header.

We try to detect the zlib header, and if it does not exsit we teat the body is plain DEFLATE content.

This method was adapted from PEAR HTTP_Request2 by (c) Alexey Borzov

http://framework.zend.com/issues/browse/ZF-6040

Definition at line 659 of file Response.php.

    {
        if (! function_exists('gzuncompress')) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception(
                'zlib extension is required in order to decode "deflate" encoding'
            );
        }

        $zlibHeader = unpack('n', substr($body, 0, 2));
        if ($zlibHeader[1] % 31 == 0 && ord($body[0]) == 0x78 && in_array(ord($body[1]), array(0x01, 0x5e, 0x9c, 0xda))) {
            return gzuncompress($body);
        } else {
            return gzinflate($body);
        }
    }

decodeGzip()

static decodeGzip (   $body )

static

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

Currently requires PHP with zlib support

Parameters

string

$body

Returns

string

Definition at line 639 of file Response.php.

    {
        if (! function_exists('gzinflate')) {
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception(
                'zlib extension is required in order to decode "gzip" encoding'
            );
        }

        return gzinflate(substr($body, 10));
    }

extractBody()

static extractBody (   $response_str )

static

Extract the body from a response string

Parameters

string

$response_str

Returns

string

Definition at line 584 of file Response.php.

    {
        $parts = preg_split('|(?:\r\n){2}|m', $response_str, 2);
        if (isset($parts[1])) {
            return $parts[1];
        }
        return '';
    }

extractCode()

static extractCode (   $response_str )

static

Extract the response code from a response string

Parameters

string

$response_str

Returns

int

Definition at line 449 of file Response.php.

    {
        preg_match("|^HTTP/[\d\.x]+ (\d+)|", $response_str, $m);

        if (isset($m[1])) {
            return (int) $m[1];
        } else {
            return false;
        }
    }

extractHeaders()

static extractHeaders (   $response_str )

static

Extract the headers from a response string

Parameters

string

$response_str

Returns

array

Definition at line 500 of file Response.php.

    {
        $headers = array();

        // First, split body and headers. Headers are separated from the
        // message at exactly the sequence "\r\n\r\n"
        $parts = preg_split('|(?:\r\n){2}|m', $response_str, 2);
        if (! $parts[0]) {
            return $headers;
        }

        // Split headers part to lines; "\r\n" is the only valid line separator.
        $lines = explode("\r\n", $parts[0]);
        unset($parts);
        $last_header = null;

        foreach($lines as $index => $line) {
            if ($index === 0 && preg_match('#^HTTP/\d+(?:\.\d+) [1-5]\d+#', $line)) {
                // Status line; ignore
                continue;
            }

            if ($line == "") {
                // Done processing headers
                break;
            }

            // Locate headers like 'Location: ...' and 'Location:...' (note the missing space)
            if (preg_match("|^([a-zA-Z0-9\'`#$%&*+.^_\|\~!-]+):\s*(.*)|s", $line, $m)) {
                unset($last_header);
                $h_name  = strtolower($m[1]);
                $h_value = $m[2];
                Zend_Http_Header_HeaderValue::assertValid($h_value);

                if (isset($headers[$h_name])) {
                    if (! is_array($headers[$h_name])) {
                        $headers[$h_name] = array($headers[$h_name]);
                    }

                    $headers[$h_name][] = ltrim($h_value);
                    $last_header = $h_name;
                    continue;
                }

                $headers[$h_name] = ltrim($h_value);
                $last_header = $h_name;
                continue;
            }

            // Identify header continuations
            if (preg_match("|^[ \t](.+)$|s", $line, $m) && $last_header !== null) {
                $h_value = trim($m[1]);
                if (is_array($headers[$last_header])) {
                    end($headers[$last_header]);
                    $last_header_key = key($headers[$last_header]);

                    $h_value = $headers[$last_header][$last_header_key] . $h_value;
                    Zend_Http_Header_HeaderValue::assertValid($h_value);

                    $headers[$last_header][$last_header_key] = $h_value;
                    continue;
                }

                $h_value = $headers[$last_header] . $h_value;
                Zend_Http_Header_HeaderValue::assertValid($h_value);

                $headers[$last_header] = $h_value;
                continue;
            }

            // Anything else is an error condition
            #require_once 'Zend/Http/Exception.php';
            throw new Zend_Http_Exception('Invalid header line detected');
        }

        return $headers;
    }

extractMessage()

static extractMessage (   $response_str )

static

Extract the HTTP message from a response

Parameters

string

$response_str

Returns

string

Definition at line 466 of file Response.php.

    {
        preg_match("|^HTTP/[\d\.x]+ \d+ ([^\r\n]+)|", $response_str, $m);

        if (isset($m[1])) {
            return $m[1];
        } else {
            return false;
        }
    }

extractVersion()

static extractVersion (   $response_str )

static

Extract the HTTP version from a response

Parameters

string

$response_str

Returns

string

Definition at line 483 of file Response.php.

    {
        preg_match("|^HTTP/([\d\.x]+) \d+|", $response_str, $m);

        if (isset($m[1])) {
            return $m[1];
        } else {
            return false;
        }
    }

fromString()

static fromString (   $response_str )

static

Create a new Zend_Http_Response object from a string

Parameters

string

$response_str

Returns

Zend_Http_Response

Definition at line 693 of file Response.php.

    {
        $code    = self::extractCode($response_str);
        $headers = self::extractHeaders($response_str);
        $body    = self::extractBody($response_str);
        $version = self::extractVersion($response_str);
        $message = self::extractMessage($response_str);

        return new Zend_Http_Response($code, $headers, $body, $version, $message);
    }

getBody()

getBody

(

)

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

string

Definition at line 258 of file Response.php.

    {
        $body = '';

        // Decode the body if it was transfer-encoded
        switch (strtolower($this->getHeader('transfer-encoding'))) {

            // Handle chunked body
            case 'chunked':
                $body = self::decodeChunkedBody($this->body);
                break;

            // No transfer encoding, or unknown encoding extension:
            // return body as is
            default:
                $body = $this->body;
                break;
        }

        // Decode any content-encoding (gzip or deflate) if needed
        switch (strtolower($this->getHeader('content-encoding'))) {

            // Handle gzip encoding
            case 'gzip':
                $body = self::decodeGzip($body);
                break;

            // Handle deflate encoding
            case 'deflate':
                $body = self::decodeDeflate($body);
                break;

            default:
                break;
        }

        return $body;
    }

getHeader()

getHeader

(

$header

)

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

Parameters

string$header

Returns

string|array|null

Definition at line 357 of file Response.php.

    {
        $header = ucwords(strtolower($header));
        if (! is_string($header) || ! isset($this->headers[$header])) return null;

        return $this->headers[$header];
    }

getHeaders()

getHeaders

(

)

Get the response headers

Returns

array

Definition at line 346 of file Response.php.

    {
        return $this->headers;
    }

getHeadersAsString()

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

Get all headers as string

Parameters

boolean	$status_line	Whether to return the first status line (IE "HTTP 200 OK")
string	$br	Line breaks (eg. "\n", "\r\n", "<br />")

Returns

string

Definition at line 372 of file Response.php.

    {
        $str = '';

        if ($status_line) {
            $str = "HTTP/{$this->version} {$this->code} {$this->message}{$br}";
        }

        // Iterate over the headers and stringify them
        foreach ($this->headers as $name => $value)
        {
            if (is_string($value))
                $str .= "{$name}: {$value}{$br}";

            elseif (is_array($value)) {
                foreach ($value as $subval) {
                    $str .= "{$name}: {$subval}{$br}";
                }
            }
        }

        return $str;
    }

getMessage()

getMessage

(

)

Return a message describing the HTTP response code (Eg. "OK", "Not Found", "Moved Permanently")

Returns

string

Definition at line 336 of file Response.php.

    {
        return $this->message;
    }

getRawBody()

getRawBody

(

)

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

string

Definition at line 305 of file Response.php.

    {
        return $this->body;
    }

getStatus()

getStatus

(

)

Get the HTTP response status code

Returns

int

Definition at line 325 of file Response.php.

    {
        return $this->code;
    }

getVersion()

getVersion

(

)

Get the HTTP version of the response

Returns

string

Definition at line 315 of file Response.php.

    {
        return $this->version;
    }

isError()

isError

(

)

Check whether the response is an error

Returns

boolean

Definition at line 206 of file Response.php.

    {
        $restype = floor($this->code / 100);
        if ($restype == 4 || $restype == 5) {
            return true;
        }

        return false;
    }

isRedirect()

isRedirect

(

)

Check whether the response is a redirection

Returns

boolean

Definition at line 236 of file Response.php.

    {
        $restype = floor($this->code / 100);
        if ($restype == 3) {
            return true;
        }

        return false;
    }

isSuccessful()

isSuccessful

(

)

Check whether the response in successful

Returns

boolean

Definition at line 221 of file Response.php.

    {
        $restype = floor($this->code / 100);
        if ($restype == 2 || $restype == 1) { // Shouldn't 3xx count as success as well ???
            return true;
        }

        return false;
    }

responseCodeAsText()

static responseCodeAsText (   $code = null,   $http11 = true  )

static

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

Parameters

int	$code	HTTP response code
boolean	$http11	Use HTTP version 1.1

Returns

string

Definition at line 429 of file Response.php.

    {
        $messages = self::$messages;
        if (! $http11) $messages[302] = 'Moved Temporarily';

        if ($code === null) {
            return $messages;
        } elseif (isset($messages[$code])) {
            return $messages[$code];
        } else {
            return 'Unknown';
        }
    }

Field Documentation

$body

$body

protected

Definition at line 135 of file Response.php.

$code

$code

protected

Definition at line 113 of file Response.php.

$headers

$headers = array()

protected

Definition at line 128 of file Response.php.

$message

$message

protected

Definition at line 121 of file Response.php.

$messages

$messages

staticprotected

Definition at line 47 of file Response.php.

$version

$version

protected

Definition at line 106 of file Response.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Http/Response.php