Changeset 51586

Timestamp:

08/09/2021 05:19:21 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename the readonly() function to wp_readonly().

Since PHP 8.1, readonly is a reserved keyword and cannot be used as a function name.

In order to avoid PHP parser errors, the readonly() function was extracted to a separate file and is now only included conditionally on PHP < 8.1.

This commit also:

• Moves the tests for the __checked_selected_helper() function and all the related functions to their own file.
• Switches to named data providers. This makes the output when using the --testdox option more descriptive and is helpful when trying to debug which data set from a data provider failed the test.
• Improves the tests in question to make them feature-complete and expand test coverage.

Props jrf, ayeshrajans, haosun, knutsp, swissspidy, SergeyBiryukov.
Fixes #53858.

Location:

trunk

Files:

• phpunit.xml.dist (modified) (1 diff)
• src/wp-includes/general-template.php (modified) (2 diffs)
• src/wp-includes/php-compat (added)
• src/wp-includes/php-compat/readonly.php (added)
• tests/phpunit/multisite.xml (modified) (1 diff)
• tests/phpunit/tests/general/template.php (modified) (1 diff)
• tests/phpunit/tests/general/template_CheckedSelectedHelper.php (added)

trunk/phpunit.xml.dist

@@ -6 +6 @@
         colors="true"
         beStrictAboutTestsThatDoNotTestAnything="true"
+        beStrictAboutOutputDuringTests="true"
         >
     <testsuites>

trunk/src/wp-includes/general-template.php

@@ -4814 +4814 @@
  * Compares the first two arguments and if identical marks as readonly
  *
- * @since 4.9.0
+ * @since 5.9.0
  *
  * @param mixed $readonly One of the values to compare
@@ -4821 +4821 @@
  * @return string HTML attribute or empty string
  */
-function readonly( $readonly, $current = true, $echo = true ) {
+function wp_readonly( $readonly, $current = true, $echo = true ) {
     return __checked_selected_helper( $readonly, $current, $echo, 'readonly' );
+}
+
+/*
+ * Include a compat `readonly()` function on PHP < 8.1. Since PHP 8.1,
+ * `readonly` is a reserved keyword and cannot be used as a function name.
+ * In order to avoid PHP parser errors, this function was extracted
+ * to a separate file and is only included conditionally on PHP < 8.1.
+ */
+if ( PHP_VERSION_ID < 80100 ) {
+    require_once __DIR__ . '/php-compat/readonly.php';
 }
 

trunk/tests/phpunit/multisite.xml

@@ -6 +6 @@
         colors="true"
         beStrictAboutTestsThatDoNotTestAnything="true"
+        beStrictAboutOutputDuringTests="true"
         >
     <php>

trunk/tests/phpunit/tests/general/template.php

@@ -573 +573 @@
 
     /**
-     * @ticket 9862
-     * @ticket 51166
-     * @dataProvider data_selected_and_checked_with_equal_values
-     *
-     * @covers ::selected
-     * @covers ::checked
-     */
-    function test_selected_and_checked_with_equal_values( $selected, $current ) {
-        $this->assertSame( " selected='selected'", selected( $selected, $current, false ) );
-        $this->assertSame( " checked='checked'", checked( $selected, $current, false ) );
-    }
-
-    function data_selected_and_checked_with_equal_values() {
-        return array(
-            array( 'foo', 'foo' ),
-            array( '1', 1 ),
-            array( '1', true ),
-            array( 1, 1 ),
-            array( 1, true ),
-            array( true, true ),
-            array( '0', 0 ),
-            array( 0, 0 ),
-            array( '', false ),
-            array( false, false ),
-        );
-    }
-
-    /**
-     * @ticket 9862
-     * @ticket 51166
-     * @dataProvider data_selected_and_checked_with_non_equal_values
-     *
-     * @covers ::selected
-     * @covers ::checked
-     */
-    function test_selected_and_checked_with_non_equal_values( $selected, $current ) {
-        $this->assertSame( '', selected( $selected, $current, false ) );
-        $this->assertSame( '', checked( $selected, $current, false ) );
-    }
-
-    function data_selected_and_checked_with_non_equal_values() {
-        return array(
-            array( '0', '' ),
-            array( 0, '' ),
-            array( 0, false ),
-        );
-    }
-
-    /**
      * @ticket 44183
      *