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

Timestamp:

05/29/2015 08:16:22 PM (9 years ago)

Author:

wonderboymusic

Message:

Add missing doc blocks to wp-admin/includes/*.
Fix some egregious uses of tabbing.
Some functions can simply return apply_filters(...) instead of setting a variable that is immediately returned.

See #32444.

File:

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

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

@@ -21 +21 @@
     public $ftp;
 
-    public function __construct($opt = '') {
+    /**
+     *
+     * @param array $opt
+     */
+    public function __construct( $opt  = '' ) {
         $this->method = 'ftpsockets';
         $this->errors = new WP_Error();
@@ -53 +57 @@
     }
 
+    /**
+     *
+     * @return bool
+     */
     public function connect() {
         if ( ! $this->ftp )
@@ -227 +235 @@
     }
     /**
+     * @param string   $source
+     * @param string   $destination
+     * @param bool     $overwrite
+     * @param int|bool $mode
+     * @return bool
+     */
+    public function copy($source, $destination, $overwrite = false, $mode = false) {
+        if ( ! $overwrite && $this->exists($destination) )
+            return false;
+
+        $content = $this->get_contents($source);
+        if ( false === $content )
+            return false;
+
+        return $this->put_contents($destination, $content, $mode);
+    }
+    /**
      * @param string $source
      * @param string $destination
-     * @param bool $overwrite
-     * @param int|bool $mode
-     * @return bool
-     */
-    public function copy($source, $destination, $overwrite = false, $mode = false) {
-        if ( ! $overwrite && $this->exists($destination) )
-            return false;
-
-        $content = $this->get_contents($source);
-        if ( false === $content )
-            return false;
-
-        return $this->put_contents($destination, $content, $mode);
-    }
-    /**
-     * @param string $source
-     * @param string $destination
-     * @param bool $overwrite
+     * @param bool   $overwrite
      * @return bool
      */
@@ -254 +262 @@
     /**
      * @param string $file
-     * @param bool $recursive
+     * @param bool   $recursive
      * @param string $type
      * @return bool
@@ -360 +368 @@
     /**
      * @param string $path
-     * @param mixed $chmod
-     * @param mixed $chown
-     * @param mixed $chgrp
+     * @param mixed  $chmod
+     * @param mixed  $chown
+     * @param mixed  $chgrp
      * @return bool
      */
@@ -388 +396 @@
     /**
      * @param string $path
-     * @param bool $include_hidden
-     * @param bool $recursive
+     * @param bool   $include_hidden
+     * @param bool   $recursive
      * @return bool|array
      */