cvs: pear /HTTP_Request Request.php package2.xml /HTTP_Request/docs download-progress.php example.php

avb Fri May 18 19:20:12 2007 UTC

Modified files:
/pear/HTTP_Request Request.php package2.xml
/pear/HTTP_Request/docs download-progress.php example.php
Log:
Better API documentation generated
Prepare release 1.4.1


http://cvs.php.net/viewvc.cgi/pear/H...&diff_format=u
Index: pear/HTTP_Request/Request.php
diff -u pear/HTTP_Request/Request.php:1.54 pear/HTTP_Request/Request.php:1.55
--- pear/HTTP_Request/Request.php:1.54 Fri May 18 18:27:32 2007
+++ pear/HTTP_Request/Request.php Fri May 18 19:20:12 2007
@@ -40,7 +40,7 @@
* @author Alexey Borzov <avb@php.net>
* @copyright 2002-2007 Richard Heyes
* @license http://opensource.org/licenses/bsd-license.php New BSD License
- * @version CVS: $Id: Request.php,v 1.54 2007/05/18 18:27:32 avb Exp $
+ * @version CVS: $Id: Request.php,v 1.55 2007/05/18 19:20:12 avb Exp $
* @link http://pear.php.net/package/HTTP_Request/
*/

@@ -106,6 +106,9 @@
*/
class HTTP_Request
{
+ /**#@+
+ * @access private
+ */
/**
* Instance of Net_URL
* @var Net_URL
@@ -255,6 +258,7 @@
* @var array
*/
var $_socketOptions = null;
+ /**#@-*/

/**
* Constructor
@@ -975,6 +979,7 @@
* @param string name for item
* @param mixed item's values
* @return array array with the following items: array('item name', 'item value');
+ * @access private
*/
function _flattenArray($name, $values)
{
@@ -1001,6 +1006,17 @@
* Adds a Listener to the list of listeners that are notified of
* the object's events
*
+ * Events sent by HTTP_Request object
+ * - 'connect': on connection to server
+ * - 'sentRequest': after the request was sent
+ * - 'disconnect': on disconnection from server
+ *
+ * Events sent by HTTP_Response object
+ * - 'gotHeaders': after receiving response headers (headers are passed in $data)
+ * - 'tick': on receiving a part of response body (the part is passed in $data)
+ * - 'gzTick': on receiving a gzip-encoded part of response body (ditto)
+ * - 'gotBody': after receiving the response body (passes the decoded body in $data if it was gzipped)
+ *
* @param HTTP_Request_Listener listener to attach
* @return boolean whether the listener was successfully attached
* @access public
@@ -1036,20 +1052,10 @@
/**
* Notifies all registered listeners of an event.
*
- * Events sent by HTTP_Request object
- * - 'connect': on connection to server
- * - 'sentRequest': after the request was sent
- * - 'disconnect': on disconnection from server
- *
- * Events sent by HTTP_Response object
- * - 'gotHeaders': after receiving response headers (headers are passed in $data)
- * - 'tick': on receiving a part of response body (the part is passed in $data)
- * - 'gzTick': on receiving a gzip-encoded part of response body (ditto)
- * - 'gotBody': after receiving the response body (passes the decoded body in $data if it was gzipped)
- *
* @param string Event name
* @param mixed Additional data
* @access private
+ * @see HTTP_Request::attach()
*/
function _notify($event, $data = null)
{
http://cvs.php.net/viewvc.cgi/pear/H...&diff_format=u
Index: pear/HTTP_Request/package2.xml
diff -u pear/HTTP_Request/package2.xml:1.2 pear/HTTP_Request/package2.xml:1.3
--- pear/HTTP_Request/package2.xml:1.2 Mon Feb 26 19:16:18 2007
+++ pear/HTTP_Request/package2.xml Fri May 18 19:20:12 2007
@@ -22,10 +22,10 @@
<email>avb@php.net</email>
<active>yes</active>
</lead>
- <date>2007-03-xx</date>
+ <date>2007-05-18</date>
<version>
<release>1.4.1</release>
- <api>1.4.1</api>
+ <api>1.4.0</api>
</version>
<stability>
<release>stable</release>
@@ -33,8 +33,14 @@
</stability>
<license uri="http://www.opensource.org/licenses/bsd-license.php">BSD</license>
<notes>
-* Removed unintended parameter for getURL() (Bug #9586)
-* Improved API documentation (Bug #9984)
+* Removed bogus parameter for getURL() (Bug #9586, thanks to Martin Jansen)
+* Improved API documentation (Bug #9984, thanks to Martin Jansen)
+* Fixed wrong Content-Length if using mbstring function overloading (bug #10605)
+* Fixed bogus &quot;data CRC check failed&quot; error on 64-bit systems (bug #10790,
+ thanks to Bill Moran)
+* Redone the way package handles mbstring function overloading, this will allow
+ using gzip Content-Encoding when said overloading is switched on
+* Added proper header comment blocks, improved phpdoc comments
</notes>
<contents>
<dir name="/">
@@ -43,9 +49,13 @@
<file baseinstalldir="HTTP" name="example.php" role="doc"/>
</dir>
<dir name="Request">
- <file baseinstalldir="HTTP" name="Listener.php" role="php"/>
+ <file baseinstalldir="HTTP" name="Listener.php" role="php">
+ <tasks:replace from="@package_version@" to="version" type="package-info" />
+ </file>
</dir>
- <file baseinstalldir="HTTP" name="Request.php" role="php"/>
+ <file baseinstalldir="HTTP" name="Request.php" role="php">
+ <tasks:replace from="@package_version@" to="version" type="package-info" />
+ </file>
</dir>
</contents>
<dependencies>
http://cvs.php.net/viewvc.cgi/pear/H...&diff_format=u
Index: pear/HTTP_Request/docs/download-progress.php
diff -u pear/HTTP_Request/docs/download-progress.php:1.2 pear/HTTP_Request/docs/download-progress.php:1.3
--- pear/HTTP_Request/docs/download-progress.php:1.2 Fri May 18 10:33:31 2007
+++ pear/HTTP_Request/docs/download-progress.php Fri May 18 19:20:12 2007
@@ -6,11 +6,16 @@
* Note two things:
* 1) The file should be run in console, not in browser;
* 2) You should turn output buffering OFF for this to work properly.
- *
- * @version CVS: $Id: download-progress.php,v 1.2 2007/05/18 10:33:31 avb Exp $
+ *
+ * @category HTTP
+ * @package HTTP_Request
+ * @version CVS: $Id: download-progress.php,v 1.3 2007/05/18 19:20:12 avb Exp $
* @ignore
*/

+/**
+ * Class for performing HTTP requests
+ */
require_once 'HTTP/Request.php';
require_once 'HTTP/Request/Listener.php';
require_once 'Console/ProgressBar.php';
@@ -19,6 +24,13 @@

set_time_limit(0);

+/**
+ * A Listener for HTTP_Request that draws download progress indicator
+ *
+ * @category HTTP
+ * @package HTTP_Request
+ * @ignore
+ */
class HTTP_Request_DownloadListener extends HTTP_Request_Listener
{
/**
@@ -28,7 +40,7 @@
var $_fp;

/**
- * Console_ProgressBar intance used to display the indicator
+ * Console_ProgressBar instance used to display the indicator
* @var object
*/
var $_bar;
http://cvs.php.net/viewvc.cgi/pear/H...&diff_format=u
Index: pear/HTTP_Request/docs/example.php
diff -u pear/HTTP_Request/docs/example.php:1.6 pear/HTTP_Request/docs/example.php:1.7
--- pear/HTTP_Request/docs/example.php:1.6 Fri May 18 10:33:31 2007
+++ pear/HTTP_Request/docs/example.php Fri May 18 19:20:12 2007
@@ -36,9 +36,15 @@
/**
* This will grab a webpage and display it
*
- * @version CVS: $Id: example.php,v 1.6 2007/05/18 10:33:31 avb Exp $
+ * @category HTTP
+ * @package HTTP_Request
+ * @version CVS: $Id: example.php,v 1.7 2007/05/18 19:20:12 avb Exp $
* @ignore
*/
+
+/**
+ * Class for performing HTTP requests
+ */
include('HTTP/Request.php');

$req = &new HTTP_Request('http://www.php.net');