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

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

@@ -3 +3 @@
  * Iterator for arrays requiring filtered values
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\Utilities
  */
+
+namespace WpOrg\Requests\Utility;
+
+use ArrayIterator;
+use ReturnTypeWillChange;
+use WpOrg\Requests\Exception\InvalidArgument;
+use WpOrg\Requests\Utility\InputValidator;
 
 /**
  * Iterator for arrays requiring filtered values
  *
- * @package Requests
- * @subpackage Utilities
+ * @package Requests\Utilities
  */
-class Requests_Utility_FilteredIterator extends ArrayIterator {
+final class FilteredIterator extends ArrayIterator {
     /**
      * Callback to run as a filter
@@ -19 +24 @@
      * @var callable
      */
-    protected $callback;
+    private $callback;
 
     /**
@@ -26 +31 @@
      * @param array $data
      * @param callable $callback Callback to be called on each value
+     *
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $data argument is not iterable.
      */
     public function __construct($data, $callback) {
+        if (InputValidator::is_iterable($data) === false) {
+            throw InvalidArgument::create(1, '$data', 'iterable', gettype($data));
+        }
+
         parent::__construct($data);
 
-        $this->callback = $callback;
+        if (is_callable($callback)) {
+            $this->callback = $callback;
+        }
+    }
+
+    /**
+     * @inheritdoc
+     *
+     * @phpcs:disable PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
+     */
+    #[ReturnTypeWillChange]
+    public function __unserialize($data) {}
+    // phpcs:enable
+
+    public function __wakeup() {
+        unset($this->callback);
     }
 
@@ -38 +64 @@
      * @return string
      */
+    #[ReturnTypeWillChange]
     public function current() {
         $value = parent::current();
@@ -51 +78 @@
      * @inheritdoc
      */
-    public function unserialize($serialized) {}
-
-    /**
-     * @inheritdoc
-     *
-     * @phpcs:disable PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.MethodDoubleUnderscore,PHPCompatibility.FunctionNameRestrictions.NewMagicMethods.__unserializeFound
-     */
-    public function __unserialize($serialized) {}
-
-    public function __wakeup() {
-        unset($this->callback);
-    }
+    #[ReturnTypeWillChange]
+    public function unserialize($data) {}
 }