Changeset 43037

Timestamp:

04/30/2018 04:16:43 AM (7 years ago)

Author:

SergeyBiryukov

Message:

General: Introduce a polyfill for is_iterable() function added in PHP 7.1.

Props jrf, schlessera, desrosj.
Merges [43036] to the 4.9 branch.
See #43619.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-includes/compat.php (modified) (2 diffs)
• tests/phpunit/tests/compat.php (modified) (1 diff)

branches/4.9/src/wp-includes/compat.php

@@ -504 +504 @@
      *
      * Verify that the content of a variable is an array or an object
-     * implementing Countable.
+     * implementing the Countable interface.
      *
      * @since 4.9.6
@@ -516 +516 @@
     }
 }
+
+if ( ! function_exists( 'is_iterable' ) ) {
+    /**
+     * Polyfill for is_iterable() function added in PHP 7.1.
+     *
+     * Verify that the content of a variable is an array or an object
+     * implementing the Traversable interface.
+     *
+     * @since 4.9.6
+     *
+     * @param mixed $var The value to check.
+     *
+     * @return bool True if `$var` is iterable, false otherwise.
+     */
+    function is_iterable( $var ) {
+        return ( is_array( $var ) || $var instanceof Traversable );
+    }
+}

branches/4.9/tests/phpunit/tests/compat.php

@@ -231 +231 @@
         );
     }
+
+    /**
+     * @ticket 43619
+     */
+    function test_is_iterable_availability() {
+        $this->assertTrue( function_exists( 'is_iterable' ) );
+    }
+
+    /**
+     * Test is_iterable() polyfill.
+     *
+     * @ticket 43619
+     *
+     * @dataProvider iterable_variable_test_data
+     */
+    function test_is_iterable_functionality( $variable, $is_iterable ) {
+        $this->assertEquals( is_iterable( $variable ), $is_iterable );
+    }
+
+    /**
+     * Data provider for test_is_iterable_functionality().
+     *
+     * @ticket 43619
+     *
+     * @return array {
+     *     @type array {
+     *         @type mixed $variable    Variable to check.
+     *         @type bool  $is_iterable The expected return value of PHP 7.1 is_iterable() function.
+     *     }
+     * }
+     */
+    public function iterable_variable_test_data() {
+        return array(
+            array( array(), true ),
+            array( array( 1, 2, 3 ), true ),
+            array( new ArrayIterator( array( 1, 2, 3 ) ), true ),
+            array( 1, false ),
+            array( 3.14, false ),
+            array( new stdClass(), false ),
+        );
+    }
 }