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

Timestamp:

11/25/2021 01:10:30 AM (3 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/Response/Headers.php (modified) (7 diffs)

trunk/src/wp-includes/Requests/Response/Headers.php

@@ -6 +6 @@
  */
 
+namespace WpOrg\Requests\Response;
+
+use WpOrg\Requests\Exception;
+use WpOrg\Requests\Exception\InvalidArgument;
+use WpOrg\Requests\Utility\CaseInsensitiveDictionary;
+use WpOrg\Requests\Utility\FilteredIterator;
+
 /**
  * Case-insensitive dictionary, suitable for HTTP headers
@@ -11 +18 @@
  * @package Requests
  */
-class Requests_Response_Headers extends Requests_Utility_CaseInsensitiveDictionary {
+class Headers extends CaseInsensitiveDictionary {
     /**
      * Get the given header
      *
-     * Unlike {@see self::getValues()}, this returns a string. If there are
+     * Unlike {@see \WpOrg\Requests\Response\Headers::getValues()}, this returns a string. If there are
      * multiple values, it concatenates them with a comma as per RFC2616.
      *
@@ -21 +28 @@
      * Set-Cookie headers.
      *
-     * @param string $key
+     * @param string $offset
      * @return string|null Header value
      */
-    public function offsetGet($key) {
-        $key = strtolower($key);
-        if (!isset($this->data[$key])) {
+    public function offsetGet($offset) {
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
+        }
+
+        if (!isset($this->data[$offset])) {
             return null;
         }
 
-        return $this->flatten($this->data[$key]);
+        return $this->flatten($this->data[$offset]);
     }
 
@@ -36 +46 @@
      * Set the given item
      *
-     * @throws Requests_Exception On attempting to use dictionary as list (`invalidset`)
+     * @param string $offset Item name
+     * @param string $value Item value
      *
-     * @param string $key Item name
-     * @param string $value Item value
+     * @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)
      */
-    public function offsetSet($key, $value) {
-        if ($key === null) {
-            throw new Requests_Exception('Object is a dictionary, not a list', 'invalidset');
+    public function offsetSet($offset, $value) {
+        if ($offset === null) {
+            throw new Exception('Object is a dictionary, not a list', 'invalidset');
         }
 
-        $key = strtolower($key);
-
-        if (!isset($this->data[$key])) {
-            $this->data[$key] = array();
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
         }
 
-        $this->data[$key][] = $value;
+        if (!isset($this->data[$offset])) {
+            $this->data[$offset] = [];
+        }
+
+        $this->data[$offset][] = $value;
     }
 
@@ -58 +70 @@
      * Get all values for a given header
      *
-     * @param string $key
+     * @param string $offset
      * @return array|null Header values
+     *
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not valid as an array key.
      */
-    public function getValues($key) {
-        $key = strtolower($key);
-        if (!isset($this->data[$key])) {
+    public function getValues($offset) {
+        if (!is_string($offset) && !is_int($offset)) {
+            throw InvalidArgument::create(1, '$offset', 'string|int', gettype($offset));
+        }
+
+        $offset = strtolower($offset);
+        if (!isset($this->data[$offset])) {
             return null;
         }
 
-        return $this->data[$key];
+        return $this->data[$offset];
     }
 
@@ -78 +96 @@
      * @param string|array $value Value to flatten
      * @return string Flattened value
+     *
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not a string or an array.
      */
     public function flatten($value) {
-        if (is_array($value)) {
-            $value = implode(',', $value);
+        if (is_string($value)) {
+            return $value;
         }
 
-        return $value;
+        if (is_array($value)) {
+            return implode(',', $value);
+        }
+
+        throw InvalidArgument::create(1, '$value', 'string|array', gettype($value));
     }
 
@@ -90 +114 @@
      * Get an iterator for the data
      *
-     * Converts the internal
-     * @return ArrayIterator
+     * Converts the internally stored values to a comma-separated string if there is more
+     * than one value for a key.
+     *
+     * @return \ArrayIterator
      */
     public function getIterator() {
-        return new Requests_Utility_FilteredIterator($this->data, array($this, 'flatten'));
+        return new FilteredIterator($this->data, [$this, 'flatten']);
     }
 }