Changeset 37989

Timestamp:

07/06/2016 05:50:44 PM (8 years ago)

Author:

rmccue

Message:

HTTP API: Switch back to returning an array.

The array-compatibility object we started returning in r37428 unfortunately isn't enough like an array. In particular, is_array() checks fail, despite the object implementing ArrayAccess. Mea culpa.

This moves the WP_HTTP_Response object to a new http_response key in the array, and changes the value back to an actual array.

Fixes #37097.
See #33055.

Location:

trunk

Files:

• src/wp-includes/class-http.php (modified) (2 diffs)
• src/wp-includes/class-wp-http-requests-response.php (modified) (3 diffs)
• tests/phpunit/tests/http/functions.php (modified) (1 diff)

trunk/src/wp-includes/class-http.php

@@ -349 +349 @@
 
         try {
-            $response = Requests::request( $url, $headers, $data, $type, $options );
+            $requests_response = Requests::request( $url, $headers, $data, $type, $options );
 
             // Convert the response into an array
-            $response = new WP_HTTP_Requests_Response( $response, $r['filename'] );
+            $http_response = new WP_HTTP_Requests_Response( $requests_response, $r['filename'] );
+            $response = $http_response->to_array();
+
+            // Add the original object to the array.
+            $response['http_response'] = $http_response;
         }
         catch ( Requests_Exception $e ) {
@@ -383 +387 @@
                 ),
                 'cookies' => array(),
+                'http_response' => null,
             );
         }

trunk/src/wp-includes/class-wp-http-requests-response.php

@@ -2 +2 @@
 
 /**
- * Wrapper object for a Requests_Response for compatibility.
+ * Wrapper object for a Requests_Response for standardisation.
  *
  * @package WordPress
@@ -8 +8 @@
  * @since 4.6.0
  */
-class WP_HTTP_Requests_Response extends WP_HTTP_Response implements ArrayAccess {
+class WP_HTTP_Requests_Response extends WP_HTTP_Response {
     /**
      * Requests Response object.
@@ -143 +143 @@
 
     /**
-     * Check if an ArrayAccess offset exists.
+     * Convert the object to a WP_Http response array.
      *
-     * This is for array access back-compat.
-     *
-     * @param string|int $key Array offset.
-     * @return bool True if the offset exists, false otherwise.
+     * @return array WP_Http response array, per WP_Http::request().
      */
-    public function offsetExists( $key ) {
-        $allowed = array( 'headers', 'body', 'response', 'cookies', 'filename' );
-        return in_array( $key, $allowed );
-    }
-
-    /**
-     * Get an ArrayAccess value.
-     *
-     * This is for array access back-compat.
-     *
-     * @param string|int $key Array offset to get.
-     * @return mixed Value if the key is a valid offset, null if invalid.
-     */
-    public function offsetGet( $key ) {
-        switch ( $key ) {
-            case 'headers':
-                return $this->get_headers();
-
-            case 'body':
-                return $this->get_data();
-
-            case 'response':
-                return array(
-                    'code'    => $this->get_status(),
-                    'message' => get_status_header_desc( $this->get_status() ),
-                );
-
-            case 'cookies':
-                return $this->get_cookies();
-
-            case 'filename':
-                return $this->filename;
-        }
-
-        return null;
-    }
-
-    /**
-     * Set an ArrayAccess value.
-     *
-     * This is for array access back-compat.
-     *
-     * @param string|int $key Array offset to set.
-     * @param mixed $value Value to set.
-     */
-    public function offsetSet( $key, $value ) {
-        switch ( $key ) {
-            case 'headers':
-                $this->set_headers( $value );
-                break;
-
-            case 'body':
-                $this->set_data( $value );
-                break;
-
-            case 'response':
-                if ( isset( $value['code'] ) ) {
-                    $this->set_status( $value['code'] );
-                }
-                break;
-
-            case 'filename':
-                $this->filename = $value;
-                break;
-        }
-    }
-
-    /**
-     * Unset an ArrayAccess value.
-     *
-     * This is for array access back-compat.
-     *
-     * @param string|int $key Array offset to remove.
-     */
-    public function offsetUnset( $key ) {
-        $this->offsetSet( $key, null );
+    public function to_array() {
+        return array(
+            'headers' => $this->get_headers(),
+            'body' => $this->get_data(),
+            'response' => array(
+                'code'    => $this->get_status(),
+                'message' => get_status_header_desc( $this->get_status() ),
+            ),
+            'cookies' => $this->get_cookies(),
+            'filename' => $this->filename,
+        );
     }
 }

trunk/tests/phpunit/tests/http/functions.php

@@ -23 +23 @@
         $this->assertEquals( '40148', $headers['content-length'] );
         $this->assertEquals( '200', wp_remote_retrieve_response_code( $response ) );
+    }
+
+    /**
+     * @depends test_head_request
+     */
+    function test_returns_array() {
+        $url = 'https://asdftestblog1.files.wordpress.com/2007/09/2007-06-30-dsc_4700-1.jpg';
+        $response = wp_remote_head( $url );
+        $this->assertInternalType( 'array', $response );
     }