golem
/
twentyGOLEM
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clean up the HTTP inline docs to reflect the times. props jacobsantos, fixes #12882. 

git-svn-id: http://svn.automattic.com/wordpress/trunk@14050 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
nacin 2010-04-10 11:23:21 +00:00
parent 3ad70c3e8c
commit 880b27ee2b
1 changed files with 19 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
wp-includes/class-http.php
View File

@ -2,7 +2,8 @@
/** /**
* Simple and uniform HTTP request API. * Simple and uniform HTTP request API.
* *
* Will eventually replace and standardize the WordPress HTTP requests made. * Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk
* decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations.
* *
* @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
* *
@ -14,12 +15,9 @@
/** /**
* WordPress HTTP Class for managing HTTP Transports and making HTTP requests. * WordPress HTTP Class for managing HTTP Transports and making HTTP requests.
* *
* This class is called for the functionality of making HTTP requests and should replace Snoopy * This class is called for the functionality of making HTTP requests and replaces Snoopy
* functionality, eventually. There is no available functionality to add HTTP transport * functionality. There is no available functionality to add HTTP transport implementations, since
* implementations, since most of the HTTP transports are added and available for use. * most of the HTTP transports are added and available for use.
*
* The exception is that cURL is not available as a transport and lacking an implementation. It will
* be added later and should be a patch on the WordPress Trac.
* *
* There are no properties, because none are needed and for performance reasons. Some of the * There are no properties, because none are needed and for performance reasons. Some of the
* functions are static and while they do have some overhead over functions in PHP4, the purpose is * functions are static and while they do have some overhead over functions in PHP4, the purpose is
@ -52,11 +50,10 @@ class WP_Http {
/** /**
* PHP5 style Constructor - Set up available transport if not available. * PHP5 style Constructor - Set up available transport if not available.
* *
* PHP4 does not have the 'self' keyword and since WordPress supports PHP4, * PHP4 does not have the 'self' keyword and since WordPress supports PHP4, the class needs to
* the class needs to be used for the static call. * be used for the static call. The transport are set up to save time and will only be created
* * once. This class can be created many times without having to go through the step of finding
* The transport are set up to save time. This should only be called once, so * which transports are available.
* the overhead should be fine.
* *
* @since 2.7.0 * @since 2.7.0
* @return WP_Http * @return WP_Http
@ -69,20 +66,18 @@ class WP_Http {
/** /**
* Tests the WordPress HTTP objects for an object to use and returns it. * Tests the WordPress HTTP objects for an object to use and returns it.
* *
* Tests all of the objects and returns the object that passes. Also caches * Tests all of the objects and returns the object that passes. Also caches that object to be
* that object to be used later. * used later.
* *
* The order for the GET/HEAD requests are HTTP Extension, cURL, Streams, Fopen, * The order for the GET/HEAD requests are HTTP Extension, cURL, Streams, Fopen, and finally
* and finally Fsockopen. fsockopen() is used last, because it has the most * Fsockopen. fsockopen() is used last, because it has the most overhead in its implementation.
* overhead in its implementation. There isn't any real way around it, since * There isn't any real way around it, since redirects have to be supported, much the same way
* redirects have to be supported, much the same way the other transports * the other transports also handle redirects.
* also handle redirects.
* *
* There are currently issues with "localhost" not resolving correctly with * There are currently issues with "localhost" not resolving correctly with DNS. This may cause
* DNS. This may cause an error "failed to open stream: A connection attempt * an error "failed to open stream: A connection attempt failed because the connected party did
* failed because the connected party did not properly respond after a * not properly respond after a period of time, or established connection failed because [the]
* period of time, or established connection failed because connected host * connected host has failed to respond."
* has failed to respond."
* *
* @since 2.7.0 * @since 2.7.0
* @access private * @access private