Changeset 53937

Timestamp:

08/24/2022 01:49:36 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Remove dynamic properties in WP_UnitTestCase_Base.

Dynamic (non-explicitly declared) properties are deprecated as of PHP 8.2 and are expected to become a fatal error in PHP 9.0.

In this particular case, the scandir() method sets a dynamic $matched_dirs property, which is subsequently used in the delete_folders() method.

This commit removes the need for the property. Effectively, this changes the scandir() method to return an array of the matched directories instead of setting the property by using recursion in the method itself in an optimized manner.

Note the array_merge() not being in the loop itself, but at the very end of the function. This is for performance reasons, see ​clearPHP: No array_merge() In Loops for a more detailed explanation of this.

It has been verified in detail that the actual results of the previous version of the method and this version match, even when the paths passed are more complex and have deeper nested subdirectories.

Follow-up to [30658], [53557], [53558], [53850], [53851], [53852], [53853], [53854], [53856], [53916], [53935], [53936].

Props jrf, johnbillion, markjaquith, SergeyBiryukov.
See #56033.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (2 diffs)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -1422 +1422 @@
          */
         public function delete_folders( $path ) {
-                $this->matched_dirs = array();
                 if ( ! is_dir( $path ) ) {
                         return;
                 }
 
-                $this->scandir( $path );
-                foreach ( array_reverse( $this->matched_dirs ) as $dir ) {
+                $matched_dirs = $this->scandir( $path );
+
+                foreach ( array_reverse( $matched_dirs ) as $dir ) {
                         rmdir( $dir );
                 }
+
                 rmdir( $path );
         }
 
         /**
-         * Retrieves all directories contained inside a directory and stores them in the `$matched_dirs` property.
+         * Retrieves all directories contained inside a directory.
          * Hidden directories are ignored.
          *
@@ -1441 +1442 @@
          *
          * @since 4.1.0
+         * @since 6.1.0 No longer sets a (dynamic) property to keep track of the directories,
+         *              but returns an array of the directories instead.
          *
          * @param string $dir Path to the directory to scan.
+         * @return string[] List of directories.
          */
         public function scandir( $dir ) {
+                $matched_dirs = array();
+
                 foreach ( scandir( $dir ) as $path ) {
                         if ( 0 !== strpos( $path, '.' ) && is_dir( $dir . '/' . $path ) ) {
-                                $this->matched_dirs[] = $dir . '/' . $path;
-                                $this->scandir( $dir . '/' . $path );
-                        }
-                }
+                                $matched_dirs[] = array( $dir . '/' . $path );
+                                $matched_dirs[] = $this->scandir( $dir . '/' . $path );
+                        }
+                }
+
+                /*
+                 * Compatibility check for PHP < 7.4, where array_merge() expects at least one array.
+                 * See: https://3v4l.org/BIQMA
+                 */
+                if ( array() === $matched_dirs ) {
+                        return array();
+                }
+
+                return array_merge( ...$matched_dirs );
         }