Changeset 47122 for trunk/tests/phpunit/includes/mock-fs.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/includes/mock-fs.php (modified) (7 diffs)

trunk/tests/phpunit/includes/mock-fs.php

@@ -6 +6 @@
     private $fs = null;
 
-    // Holds a array of /path/to/file.php and /path/to/dir/ map to an object in $fs above
-    // a fast more efficient way of determining if a path exists, and access to that node
+    // Holds a array of /path/to/file.php and /path/to/dir/ map to an object in $fs above.
+    // A fast, more efficient way of determining if a path exists, and access to that node.
     private $fs_map = array();
 
@@ -27 +27 @@
         $folder = $this->find_folder( $path );
 
-        // Perhaps the FTP folder is rooted at the WordPress installation, Check for wp-includes folder in root, Could have some false positives, but rare.
+        // Perhaps the FTP folder is rooted at the WordPress installation.
+        // Check for wp-includes folder in root, could have some false positives, but rare.
         if ( ! $folder && $this->is_dir( '/wp-includes' ) ) {
             $folder = '/';
@@ -34 +35 @@
     }
 
-    // Mock FS specific functions:
+    // Mock FS-specific functions:
 
     /**
@@ -45 +46 @@
             '/' => $this->fs,
         );
-        $this->cache  = array(); // Used by find_folder() and friends
+        $this->cache  = array(); // Used by find_folder() and friends.
         $this->cwd    = isset( $this->fs_map[ $home_dir ] ) ? $this->fs_map[ $home_dir ] : '/';
         $this->setfs( $paths );
@@ -61 +62 @@
 
         foreach ( $paths as $path ) {
-            // Allow for comments
+            // Allow for comments.
             if ( '#' === $path[0] ) {
                 continue;
             }
 
-            // Directories
+            // Directories.
             if ( '/' === $path[ strlen( $path ) - 1 ] ) {
                 $this->mkdir( $path );
-            } else { // Files (with dummy content for now)
+            } else { // Files (with dummy content for now).
                 $this->put_contents( $path, 'This is a test file' );
             }
@@ -210 +211 @@
 
 class MockFS_Node {
-    public $name; // The "name" of the entry, does not include a slash (exception, root)
-    public $type; // The type of the entry 'f' for file, 'd' for Directory
+    public $name; // The "name" of the entry, does not include a slash (exception, root).
+    public $type; // The type of the entry 'f' for file, 'd' for directory.
     public $path; // The full path to the entry.
 
@@ -230 +231 @@
 class MockFS_Directory_Node extends MockFS_Node {
     public $type     = 'd';
-    public $children = array(); // The child nodes of this directory
+    public $children = array(); // The child nodes of this directory.
 }
 
 class MockFS_File_Node extends MockFS_Node {
     public $type     = 'f';
-    public $contents = ''; // The contents of the file
+    public $contents = ''; // The contents of the file.
 
     function __construct( $path, $contents = '' ) {