Changeset 52244 for trunk/src/wp-includes/Requests/Utility/CaseInsensitiveDictionary.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/Utility/CaseInsensitiveDictionary.php (modified) (8 diffs)

trunk/src/wp-includes/Requests/Utility/CaseInsensitiveDictionary.php

@@ -3 +3 @@
  * Case-insensitive dictionary, suitable for HTTP headers
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\Utilities
  */
+
+namespace WpOrg\Requests\Utility;
+
+use ArrayAccess;
+use ArrayIterator;
+use IteratorAggregate;
+use ReturnTypeWillChange;
+use WpOrg\Requests\Exception;
 
 /**
  * Case-insensitive dictionary, suitable for HTTP headers
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\Utilities
  */
-class Requests_Utility_CaseInsensitiveDictionary implements ArrayAccess, IteratorAggregate {
+class CaseInsensitiveDictionary implements ArrayAccess, IteratorAggregate {
     /**
      * Actual item data
@@ -19 +25 @@
      * @var array
      */
-    protected $data = array();
+    protected $data = [];
 
     /**
@@ -26 +32 @@
      * @param array $data Dictionary/map to convert to case-insensitive
      */
-    public function __construct(array $data = array()) {
-        foreach ($data as $key => $value) {
-            $this->offsetSet($key, $value);
+    public function __construct(array $data = []) {
+        foreach ($data as $offset => $value) {
+            $this->offsetSet($offset, $value);
         }
     }
@@ -35 +41 @@
      * Check if the given item exists
      *
-     * @param string $key Item key
+     * @param string $offset Item key
      * @return boolean Does the item exist?
      */
-    public function offsetExists($key) {
-        $key = strtolower($key);
-        return isset($this->data[$key]);
+    #[ReturnTypeWillChange]
+    public function offsetExists($offset) {
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
+        }
+
+        return isset($this->data[$offset]);
     }
 
@@ -46 +56 @@
      * Get the value for the item
      *
-     * @param string $key Item key
-     * @return string|null Item value (null if offsetExists is false)
+     * @param string $offset Item key
+     * @return string|null Item value (null if the item key doesn't exist)
      */
-    public function offsetGet($key) {
-        $key = strtolower($key);
-        if (!isset($this->data[$key])) {
+    #[ReturnTypeWillChange]
+    public function offsetGet($offset) {
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
+        }
+
+        if (!isset($this->data[$offset])) {
             return null;
         }
 
-        return $this->data[$key];
+        return $this->data[$offset];
     }
 
@@ -61 +75 @@
      * 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');
+    #[ReturnTypeWillChange]
+    public function offsetSet($offset, $value) {
+        if ($offset === null) {
+            throw new Exception('Object is a dictionary, not a list', 'invalidset');
         }
 
-        $key              = strtolower($key);
-        $this->data[$key] = $value;
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
+        }
+
+        $this->data[$offset] = $value;
     }
 
@@ -78 +96 @@
      * Unset the given header
      *
-     * @param string $key
+     * @param string $offset
      */
-    public function offsetUnset($key) {
-        unset($this->data[strtolower($key)]);
+    #[ReturnTypeWillChange]
+    public function offsetUnset($offset) {
+        if (is_string($offset)) {
+            $offset = strtolower($offset);
+        }
+
+        unset($this->data[$offset]);
     }
 
@@ -87 +110 @@
      * Get an iterator for the data
      *
-     * @return ArrayIterator
+     * @return \ArrayIterator
      */
+    #[ReturnTypeWillChange]
     public function getIterator() {
         return new ArrayIterator($this->data);