Changeset 53872

Timestamp:

08/09/2022 11:32:01 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename the $file parameter to $path in some WP_Filesystem_* methods.

This aims to bring more clarity to the code, and applies to methods where the path can be a file or a directory:

• WP_Filesystem_*::exists()
• WP_Filesystem_*::is_writable()

Follow-up to [6779], [25560].

See #55647.

Location:

trunk/src/wp-admin/includes

Files:

• class-wp-filesystem-base.php (modified) (2 diffs)
• class-wp-filesystem-direct.php (modified) (2 diffs)
• class-wp-filesystem-ftpext.php (modified) (2 diffs)
• class-wp-filesystem-ftpsockets.php (modified) (2 diffs)
• class-wp-filesystem-ssh2.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-filesystem-base.php

@@ -664 +664 @@
          * @abstract
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file exists or not.
-         */
-        public function exists( $file ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path exists or not.
+         */
+        public function exists( $path ) {
                 return false;
         }
@@ -716 +716 @@
          * @abstract
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file is writable.
-         */
-        public function is_writable( $file ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path is writable.
+         */
+        public function is_writable( $path ) {
                 return false;
         }

trunk/src/wp-admin/includes/class-wp-filesystem-direct.php

@@ -400 +400 @@
          * @since 2.5.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file exists or not.
-         */
-        public function exists( $file ) {
-                return @file_exists( $file );
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path exists or not.
+         */
+        public function exists( $path ) {
+                return @file_exists( $path );
         }
 
@@ -448 +448 @@
          * @since 2.5.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file is writable.
-         */
-        public function is_writable( $file ) {
-                return @is_writable( $file );
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path is writable.
+         */
+        public function is_writable( $path ) {
+                return @is_writable( $path );
         }
 

trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php

@@ -416 +416 @@
          *              and ftp_rawlist() to check for file existence.
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file exists or not.
-         */
-        public function exists( $file ) {
-                if ( $this->is_dir( $file ) ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path exists or not.
+         */
+        public function exists( $path ) {
+                if ( $this->is_dir( $path ) ) {
                         return true;
                 }
 
-                return ! empty( ftp_rawlist( $this->link, $file ) );
+                return ! empty( ftp_rawlist( $this->link, $path ) );
         }
 
@@ -476 +476 @@
          * @since 2.5.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file is writable.
-         */
-        public function is_writable( $file ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path is writable.
+         */
+        public function is_writable( $path ) {
                 return true;
         }

trunk/src/wp-admin/includes/class-wp-filesystem-ftpsockets.php

@@ -418 +418 @@
          *              and file size to check for file existence.
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file exists or not.
-         */
-        public function exists( $file ) {
-                if ( $this->is_dir( $file ) ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path exists or not.
+         */
+        public function exists( $path ) {
+                if ( $this->is_dir( $path ) ) {
                         return true;
                 }
 
-                return is_numeric( $this->size( $file ) );
+                return is_numeric( $this->size( $path ) );
         }
 
@@ -485 +485 @@
          * @since 2.5.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file is writable.
-         */
-        public function is_writable( $file ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path is writable.
+         */
+        public function is_writable( $path ) {
                 return true;
         }

trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

@@ -558 +558 @@
          * @since 2.7.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file exists or not.
-         */
-        public function exists( $file ) {
-                return file_exists( $this->sftp_path( $file ) );
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path exists or not.
+         */
+        public function exists( $path ) {
+                return file_exists( $this->sftp_path( $path ) );
         }
 
@@ -606 +606 @@
          * @since 2.7.0
          *
-         * @param string $file Path to file or directory.
-         * @return bool Whether $file is writable.
-         */
-        public function is_writable( $file ) {
+         * @param string $path Path to file or directory.
+         * @return bool Whether $path is writable.
+         */
+        public function is_writable( $path ) {
                 // PHP will base its writable checks on system_user === file_owner, not ssh_user === file_owner.
                 return true;