Changeset 52244 for trunk/src/wp-includes/Requests/Transport.php

Timestamp:

11/25/2021 01:10:30 AM (4 years ago)

Author:

SergeyBiryukov

Message:

External Libraries: Update the Requests library to version 2.0.0.

This is a major release and contains breaking changes.

Most important changes to be aware of for this release:

• All code is now namespaced. Though there is a full backward compatibility layer available and the old class names are still supported, using them will generate a deprecation notice (which can be silenced by plugins if they'd need to support multiple WP versions). See the ​upgrade guide for more details.
• A lot of classes have been marked final. This should generally not affect userland code as care has been taken to not apply the final keyword to classes which are known to be extended in userland code.
• Extensive input validation has been added to Requests. When Requests is used as documented though, this will be unnoticable.
• A new WpOrg\Requests\Requests::has_capabilities() method has been introduced which can be used to address #37708.
• A new WpOrg\Requests\Response::decode_body() method has been introduced which may be usable to simplify some of the WP native wrapper code.
• Remaining PHP 8.0 compatibility fixed (support for named parameters).
• PHP 8.1 compatibility.

Release notes: ​https://github.com/WordPress/Requests/releases/tag/v2.0.0

For a full list of changes in this update, see the Requests GitHub:
​https://github.com/WordPress/Requests/compare/v1.8.1...v2.0.0

Follow-up to [50842], [51078].

Props jrf, schlessera, datagutten, wojsmol, dd32, dustinrue, soulseekah, costdev, szepeviktor.
Fixes #54504.

File:

• trunk/src/wp-includes/Requests/Transport.php (modified) (2 diffs)

trunk/src/wp-includes/Requests/Transport.php

@@ -3 +3 @@
  * Base HTTP transport
  *
- * @package Requests
- * @subpackage Transport
+ * @package Requests\Transport
  */
+
+namespace WpOrg\Requests;
 
 /**
  * Base HTTP transport
  *
- * @package Requests
- * @subpackage Transport
+ * @package Requests\Transport
  */
-interface Requests_Transport {
+interface Transport {
     /**
      * Perform a request
@@ -20 +20 @@
      * @param array $headers Associative array of request headers
      * @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD
-     * @param array $options Request options, see {@see Requests::response()} for documentation
+     * @param array $options Request options, see {@see \WpOrg\Requests\Requests::response()} for documentation
      * @return string Raw HTTP result
      */
-    public function request($url, $headers = array(), $data = array(), $options = array());
+    public function request($url, $headers = [], $data = [], $options = []);
 
     /**
      * Send multiple requests simultaneously
      *
-     * @param array $requests Request data (array of 'url', 'headers', 'data', 'options') as per {@see Requests_Transport::request}
-     * @param array $options Global options, see {@see Requests::response()} for documentation
-     * @return array Array of Requests_Response objects (may contain Requests_Exception or string responses as well)
+     * @param array $requests Request data (array of 'url', 'headers', 'data', 'options') as per {@see \WpOrg\Requests\Transport::request()}
+     * @param array $options Global options, see {@see \WpOrg\Requests\Requests::response()} for documentation
+     * @return array Array of \WpOrg\Requests\Response objects (may contain \WpOrg\Requests\Exception or string responses as well)
      */
     public function request_multiple($requests, $options);
 
     /**
-     * Self-test whether the transport can be used
-     * @return bool
+     * Self-test whether the transport can be used.
+     *
+     * The available capabilities to test for can be found in {@see \WpOrg\Requests\Capability}.
+     *
+     * @param array<string, bool> $capabilities Optional. Associative array of capabilities to test against, i.e. `['<capability>' => true]`.
+     * @return bool Whether the transport can be used.
      */
-    public static function test();
+    public static function test($capabilities = []);
 }