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

Timestamp:

12/01/2014 12:12:05 AM (10 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs for src/wp-admin/includes/class-wp-filesystem-*.php.

See #30224.

File:

• trunk/src/wp-admin/includes/class-wp-filesystem-direct.php (modified) (7 diffs)

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

@@ -201 +201 @@
     }
 
+    /**
+     * @param string $file
+     * @return string
+     */
     public function group($file) {
         $gid = @filegroup($file);
@@ -211 +215 @@
     }
 
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param bool   $overwrite
+     * @param int    $mode
+     * @return bool
+     */
     public function copy($source, $destination, $overwrite = false, $mode = false) {
         if ( ! $overwrite && $this->exists($destination) )
@@ -221 +232 @@
     }
 
+    /**
+     * @param string $source
+     * @param string $destination
+     * @param bool $overwrite
+     * @return bool
+     */
     public function move($source, $destination, $overwrite = false) {
         if ( ! $overwrite && $this->exists($destination) )
@@ -237 +254 @@
     }
 
+    /**
+     * @param string $file
+     * @param bool $recursive
+     * @param string $type
+     * @return bool
+     */
     public function delete($file, $recursive = false, $type = false) {
         if ( empty( $file ) ) // Some filesystems report this as /, which can cause non-expected recursive deletion of all files in the filesystem.
@@ -264 +287 @@
         return $retval;
     }
-
+    /**
+     * @param string $file
+     * @return bool
+     */
     public function exists($file) {
         return @file_exists($file);
     }
-
+    /**
+     * @param string $file
+     * @return bool
+     */
     public function is_file($file) {
         return @is_file($file);
     }
-
+    /**
+     * @param string $path
+     * @return bool
+     */
     public function is_dir($path) {
         return @is_dir($path);
     }
 
+    /**
+     * @param string $file
+     * @return bool
+     */
     public function is_readable($file) {
         return @is_readable($file);
     }
 
+    /**
+     * @param string $file
+     * @return bool
+     */
     public function is_writable($file) {
         return @is_writable($file);
     }
 
+    /**
+     * @param string $file
+     * @return int
+     */
     public function atime($file) {
         return @fileatime($file);
     }
 
+    /**
+     * @param string $file
+     * @return int
+     */
     public function mtime($file) {
         return @filemtime($file);
     }
 
+    /**
+     * @param string $file
+     * @return int
+     */
     public function size($file) {
         return @filesize($file);
     }
 
+    /**
+     * @param string $file
+     * @param int $time
+     * @param int $atime
+     * @return bool
+     */
     public function touch($file, $time = 0, $atime = 0) {
         if ($time == 0)
@@ -305 +363 @@
     }
 
+    /**
+     * @param string $path
+     * @param mixed  $chmod
+     * @param mixed  $chown
+     * @param mixed  $chgrp
+     * @return bool
+     */
     public function mkdir($path, $chmod = false, $chown = false, $chgrp = false) {
         // Safe mode fails with a trailing slash under certain PHP versions.
@@ -324 +389 @@
     }
 
+    /**
+     * @param string $path
+     * @param bool $recursive
+     * @return type
+     */
     public function rmdir($path, $recursive = false) {
         return $this->delete($path, $recursive);
     }
 
+    /**
+     * @param string $path
+     * @param bool $include_hidden
+     * @param bool $recursive
+     * @return bool|array
+     */
     public function dirlist($path, $include_hidden = true, $recursive = false) {
         if ( $this->is_file($path) ) {