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

Timestamp:

09/22/2013 04:43:29 AM (11 years ago)

Author:

dd32

Message:

First pass at documenting the WP_Filesystem methods. This also introduces stubs of the methods into the base class which are documented, which subclasses can override, some methods were cleaned up at the same time.
See #18476 See #23122. Props kurtpayne, bananastalktome, and, DrewAPicture

File:

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

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

@@ -1 +1 @@
 <?php
 /**
- * WordPress SSH2 Filesystem.
- *
- * @package WordPress
- * @subpackage Filesystem
- */
-
-/**
- * WordPress Filesystem Class for implementing SSH2.
+ * WordPress Filesystem Class for implementing SSH2
  *
  * To use this class you must follow these steps for PHP 5.2.6+
@@ -36 +29 @@
  * Note: as of WordPress 2.8, This utilises the PHP5+ function 'stream_get_contents'
  *
- * @since 2.7
+ * @since 2.7.0
+ *
  * @package WordPress
  * @subpackage Filesystem
- * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
@@ -209 +202 @@
     }
 
-    function chown($file, $owner, $recursive = false ) {
+    /**
+     * Change the ownership of a file / folder.
+     *
+     * @since Unknown
+     *
+     * @param string $file    Path to the file.
+     * @param mixed  $owner   A user name or number.
+     * @param bool $recursive Optional. If set True changes file owner recursivly. Defaults to False.
+     * @return bool Returns true on success or false on failure.
+     */
+    function chown( $file, $owner, $recursive = false ) {
         if ( ! $this->exists($file) )
             return false;