Changeset 43034

Timestamp:

04/30/2018 03:42:46 AM (8 years ago)

Author:

SergeyBiryukov

Message:

General: Introduce a polyfill for is_countable() function added in PHP 7.3.

Props jrf, ayeshrajans, desrosj.
See #43583.

Location:

trunk

Files:

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

trunk/src/wp-includes/compat.php

@@ -506 +506 @@
         require_once ABSPATH . WPINC . '/spl-autoload-compat.php';
 }
+
+if ( ! function_exists( 'is_countable' ) ) {
+        /**
+         * Polyfill for is_countable() function added in PHP 7.3.
+         *
+         * Verify that the content of a variable is an array or an object
+         * implementing Countable.
+         *
+         * @since 4.9.6
+         *
+         * @param mixed $var The value to check.
+         *
+         * @return bool True if `$var` is countable, false otherwise.
+         */
+        function is_countable( $var ) {
+                return ( is_array( $var ) || $var instanceof Countable );
+        }
+}

trunk/tests/phpunit/tests/compat.php

@@ -187 +187 @@
                 $this->assertEquals( array( 'foo' ), $json->decode( '["foo"]' ) );
         }
+
+        /**
+         * @ticket 43583
+         */
+        function test_is_countable_availability() {
+                $this->assertTrue( function_exists( 'is_countable' ) );
+        }
+
+        /**
+         * Test is_countable() polyfill.
+         *
+         * @ticket 43583
+         *
+         * @dataProvider countable_variable_test_data
+         */
+        function test_is_countable_functionality( $variable, $is_countable ) {
+                $this->assertEquals( is_countable( $variable ), $is_countable );
+        }
+
+        /**
+         * Data provider for test_is_countable_functionality().
+         *
+         * @ticket 43583
+         *
+         * @return array {
+         *     @type array {
+         *         @type mixed $variable     Variable to check.
+         *         @type bool  $is_countable The expected return value of PHP 7.3 is_countable() function.
+         *     }
+         * }
+         */
+        public function countable_variable_test_data() {
+                return array(
+                        array( true, false ),
+                        array( new stdClass(), false ),
+                        array( new ArrayIteratorFake(), true ),
+                        array( new CountableFake(), true ),
+                        array( 16, false ),
+                        array( null, false ),
+                        array( array( 1, 2, 3 ), true ),
+                        array( (array) 1, true ),
+                        array( (object) array( 'foo', 'bar', 'baz' ), false ),
+                );
+        }
 }
 
@@ -195 +239 @@
         }
 }
+
+class ArrayIteratorFake extends ArrayIterator {
+}
+
+class CountableFake implements Countable {
+        public function count() {
+                return 16;
+        }
+}