HTTP_Response Class Reference

List of all members.

Public Member Functions
	HTTP_Response (&$sock, &$listeners)
	process ($saveBody=true)
	_processHeader ($header)
	_parseCookie ($headervalue)
	_readChunked ()
	_notify ($event, $data=null)
Public Attributes
	$_sock
	$_protocol
	$_code
	$_headers
	$_cookies
	$_body = ''
	$_chunkLength = 0
	$_listeners = array()

---

Detailed Description

Response class to complement the Request class

Definition at line 900 of file Request.php.

---

Constructor & Destructor Documentation

HTTP_Response::HTTP_Response (  &$  sock, &$  listeners )

Constructor Parameters: object  Net_Socket socket to read the response from array  listeners attached to request Returns: mixed PEAR Error on error, true otherwise Definition at line 957 of file Request.php. { $this->_sock =& $sock; $this->_listeners =& $listeners; }

---

Member Function Documentation

HTTP_Response::_notify (  $  event, $  data = null )

Notifies all registered listeners of an event. Parameters: string  Event name mixed  Additional data private See also: HTTP_Request::_notify() Definition at line 1136 of file Request.php. References $id. Referenced by process(). { foreach (array_keys($this->_listeners) as $id) { $this->_listeners[$id]->update($this, $event, $data); } }

HTTP_Response::_parseCookie (  $  headervalue  )

Parse a Set-Cookie header to fill $_cookies array private Parameters: string  value of Set-Cookie header Definition at line 1052 of file Request.php. References $pos, and name. Referenced by _processHeader(). { $cookie = array( 'expires' => null, 'domain' => null, 'path' => null, 'secure' => false ); // Only a name=value pair if (!strpos($headervalue, ';')) { $pos = strpos($headervalue, '='); $cookie['name'] = trim(substr($headervalue, 0, $pos)); $cookie['value'] = trim(substr($headervalue, $pos + 1)); // Some optional parameters are supplied } else { $elements = explode(';', $headervalue); $pos = strpos($elements[0], '='); $cookie['name'] = trim(substr($elements[0], 0, $pos)); $cookie['value'] = trim(substr($elements[0], $pos + 1)); for ($i = 1; $i < count($elements); $i++) { if (false === strpos($elements[$i], '=')) { $elName = trim($elements[$i]); $elValue = null; } else { list ($elName, $elValue) = array_map('trim', explode('=', $elements[$i])); } $elName = strtolower($elName); if ('secure' == $elName) { $cookie['secure'] = true; } elseif ('expires' == $elName) { $cookie['expires'] = str_replace('"', '', $elValue); } elseif ('path' == $elName || 'domain' == $elName) { $cookie[$elName] = urldecode($elValue); } else { $cookie[$elName] = $elValue; } } } $this->_cookies[] = $cookie; }

HTTP_Response::_processHeader (  $  header  )

Processes the response header private Parameters: string  HTTP header Definition at line 1031 of file Request.php. References _parseCookie(). Referenced by process(). { list($headername, $headervalue) = explode(':', $header, 2); $headername_i = strtolower($headername); $headervalue = ltrim($headervalue); if ('set-cookie' != $headername_i) { $this->_headers[$headername] = $headervalue; $this->_headers[$headername_i] = $headervalue; } else { $this->_parseCookie($headervalue); } }

HTTP_Response::_readChunked (   )

Read a part of response body encoded with chunked Transfer-Encoding private Returns: string Definition at line 1103 of file Request.php. References $data, and $line. Referenced by process(). { // at start of the next chunk? if (0 == $this->_chunkLength) { $line = $this->_sock->readLine(); if (preg_match('/^([0-9a-f]+)/i', $line, $matches)) { $this->_chunkLength = hexdec($matches[1]); // Chunk with zero length indicates the end if (0 == $this->_chunkLength) { $this->_sock->readAll(); // make this an eof() return ''; } } elseif ($this->_sock->eof()) { return ''; } } $data = $this->_sock->read($this->_chunkLength); $this->_chunkLength -= strlen($data); if (0 == $this->_chunkLength) { $this->_sock->readLine(); // Trailing CRLF } return $data; }

HTTP_Response::process (  $  saveBody = true  )

Processes a HTTP response This extracts response code, headers, cookies and decodes body if it was encoded in some way public Parameters: bool  Whether to store response body in object property, set this to false if downloading a LARGE file and using a Listener. This is assumed to be true if body is gzip-encoded. Exceptions: PEAR_Error  Returns: mixed true on success, PEAR_Error in case of malformed response Definition at line 977 of file Request.php. References $data, $line, _notify(), _processHeader(), _readChunked(), and PEAR::raiseError(). { do { $line = $this->_sock->readLine(); if (sscanf($line, 'HTTP/%s %s', $http_version, $returncode) != 2) { return PEAR::raiseError('Malformed response.'); } else { $this->_protocol = 'HTTP/' . $http_version; $this->_code = intval($returncode); } while ('' !== ($header = $this->_sock->readLine())) { $this->_processHeader($header); } } while (100 == $this->_code); $this->_notify('gotHeaders', $this->_headers); // If response body is present, read it and decode $chunked = isset($this->_headers['transfer-encoding']) && ('chunked' == $this->_headers['transfer-encoding']); $gzipped = isset($this->_headers['content-encoding']) && ('gzip' == $this->_headers['content-encoding']); $hasBody = false; while (!$this->_sock->eof()) { if ($chunked) { $data = $this->_readChunked(); } else { $data = $this->_sock->read(4096); } if ('' != $data) { $hasBody = true; if ($saveBody || $gzipped) { $this->_body .= $data; } $this->_notify($gzipped? 'gzTick': 'tick', $data); } } if ($hasBody) { // Uncompress the body if needed if ($gzipped) { $this->_body = gzinflate(substr($this->_body, 10)); $this->_notify('gotBody', $this->_body); } else { $this->_notify('gotBody'); } } return true; }

---

Member Data Documentation

HTTP_Response::$_body = ''

Definition at line 936 of file Request.php.

HTTP_Response::$_chunkLength = 0

Definition at line 942 of file Request.php.

HTTP_Response::$_code

Definition at line 918 of file Request.php.

HTTP_Response::$_cookies

Definition at line 930 of file Request.php.

HTTP_Response::$_headers

Definition at line 924 of file Request.php.

HTTP_Response::$_listeners = array()

Definition at line 948 of file Request.php.

HTTP_Response::$_protocol

Definition at line 912 of file Request.php.

HTTP_Response::$_sock

Definition at line 906 of file Request.php.

---

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

• pear/HTTP/Request.php

---