WordPress 4.1.3

[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-ftpsockets.php

diff --git a/wp-admin/includes/class-wp-filesystem-ftpsockets.php b/wp-admin/includes/class-wp-filesystem-ftpsockets.php
index 817dd08e0bfeda9146b4beb270960c9f5233a119..bb7e0c2e6293ad1fcc22a8f06be46cd7962c17a1 100644 (file)
--- a/wp-admin/includes/class-wp-filesystem-ftpsockets.php
+++ b/wp-admin/includes/class-wp-filesystem-ftpsockets.php
@@ -9,23 +9,24 @@
 /**
  * WordPress Filesystem Class for implementing FTP Sockets.
  *
 /**
  * WordPress Filesystem Class for implementing FTP Sockets.
  *

- * @since 2.5
+ * @since 2.5.0

  * @package WordPress
  * @subpackage Filesystem
  * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
  * @package WordPress
  * @subpackage Filesystem
  * @uses WP_Filesystem_Base Extends class
  */
 class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {

-       var $ftp = false;
-       var $errors = null;
-       var $options = array();
+       public $ftp = false;
+       public $errors = null;
+       public $options = array();

 
 

-       function __construct($opt = '') {
+       public function __construct($opt = '') {

                $this->method = 'ftpsockets';
                $this->errors = new WP_Error();
 
                // Check if possible to use ftp functions.
                $this->method = 'ftpsockets';
                $this->errors = new WP_Error();
 
                // Check if possible to use ftp functions.

-               if ( ! @include_once ABSPATH . 'wp-admin/includes/class-ftp.php' )
-                               return false;
+               if ( ! @include_once( ABSPATH . 'wp-admin/includes/class-ftp.php' ) ) {
+                       return false;
+               }

                $this->ftp = new ftp();
 
                if ( empty($opt['port']) )
                $this->ftp = new ftp();
 
                if ( empty($opt['port']) )


@@ -53,7 +54,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                        $this->options['password'] = $opt['password'];
        }
 
                        $this->options['password'] = $opt['password'];
        }
 

-       function connect() {
+       public function connect() {

                if ( ! $this->ftp )
                        return false;
 
                if ( ! $this->ftp )
                        return false;
 


@@ -80,7 +81,11 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return true;
        }
 
                return true;
        }
 

-       function get_contents( $file ) {
+       /**
+        * @param string $file
+        * @return bool|string
+        */
+       public function get_contents( $file ) {

                if ( ! $this->exists($file) )
                        return false;
 
                if ( ! $this->exists($file) )
                        return false;
 


@@ -112,12 +117,21 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                unlink($temp);
                return $contents;
        }
                unlink($temp);
                return $contents;
        }

-
-       function get_contents_array($file) {
+       /**
+        * @param string $file
+        * @return array
+        */
+       public function get_contents_array($file) {

                return explode("\n", $this->get_contents($file) );
        }
 
                return explode("\n", $this->get_contents($file) );
        }
 

-       function put_contents($file, $contents, $mode = false ) {
+       /**
+        * @param string $file
+        * @param string $contents
+        * @param int|bool $mode
+        * @return bool
+        */
+       public function put_contents($file, $contents, $mode = false ) {

                $temp = wp_tempnam( $file );
                if ( ! $temphandle = @fopen($temp, 'w+') ) {
                        unlink($temp);
                $temp = wp_tempnam( $file );
                if ( ! $temphandle = @fopen($temp, 'w+') ) {
                        unlink($temp);


@@ -151,22 +165,33 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $ret;
        }
 
                return $ret;
        }
 

-       function cwd() {
+       public function cwd() {

                $cwd = $this->ftp->pwd();
                if ( $cwd )
                        $cwd = trailingslashit($cwd);
                return $cwd;
        }
 
                $cwd = $this->ftp->pwd();
                if ( $cwd )
                        $cwd = trailingslashit($cwd);
                return $cwd;
        }
 

-       function chdir($file) {
+       public function chdir($file) {

                return $this->ftp->chdir($file);
        }
 
                return $this->ftp->chdir($file);
        }
 

-       function chgrp($file, $group, $recursive = false ) {
+       /**
+        * @param string $file
+        * @param bool $group
+        * @param bool $recursive
+        */
+       public function chgrp($file, $group, $recursive = false ) {

                return false;
        }
 
                return false;
        }
 

-       function chmod($file, $mode = false, $recursive = false ) {
+       /**
+        * @param string $file
+        * @param int|bool $mode
+        * @param bool $recursive
+        * @return bool
+        */
+       public function chmod($file, $mode = false, $recursive = false ) {

                if ( ! $mode ) {
                        if ( $this->is_file($file) )
                                $mode = FS_CHMOD_FILE;
                if ( ! $mode ) {
                        if ( $this->is_file($file) )
                                $mode = FS_CHMOD_FILE;


@@ -187,22 +212,38 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $this->ftp->chmod($file, $mode);
        }
 
                return $this->ftp->chmod($file, $mode);
        }
 

-       function owner($file) {
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function owner($file) {

                $dir = $this->dirlist($file);
                return $dir[$file]['owner'];
        }
                $dir = $this->dirlist($file);
                return $dir[$file]['owner'];
        }

-
-       function getchmod($file) {
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function getchmod($file) {

                $dir = $this->dirlist($file);
                return $dir[$file]['permsn'];
        }
                $dir = $this->dirlist($file);
                return $dir[$file]['permsn'];
        }

-
-       function group($file) {
+       /**
+        * @param string $file
+        * @return string
+        */
+       public function group($file) {

                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }
                $dir = $this->dirlist($file);
                return $dir[$file]['group'];
        }

-
-       function copy($source, $destination, $overwrite = false, $mode = false) {
+       /**
+        * @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;
 
                if ( ! $overwrite && $this->exists($destination) )
                        return false;
 


@@ -212,12 +253,22 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
 
                return $this->put_contents($destination, $content, $mode);
        }
 
                return $this->put_contents($destination, $content, $mode);
        }

-
-       function move($source, $destination, $overwrite = false ) {
+       /**
+        * @param string $source
+        * @param string $destination
+        * @param bool $overwrite
+        * @return bool
+        */
+       public function move($source, $destination, $overwrite = false ) {

                return $this->ftp->rename($source, $destination);
        }
                return $this->ftp->rename($source, $destination);
        }

-
-       function delete($file, $recursive = false, $type = false) {
+       /**
+        * @param string $file
+        * @param bool $recursive
+        * @param string $type
+        * @return bool
+        */
+       public function delete($file, $recursive = false, $type = false) {

                if ( empty($file) )
                        return false;
                if ( 'f' == $type || $this->is_file($file) )
                if ( empty($file) )
                        return false;
                if ( 'f' == $type || $this->is_file($file) )


@@ -228,13 +279,21 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $this->ftp->mdel($file);
        }
 
                return $this->ftp->mdel($file);
        }
 

-       function exists( $file ) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function exists( $file ) {

                $list = $this->ftp->nlist( $file );
                return !empty( $list ); //empty list = no file, so invert.
                $list = $this->ftp->nlist( $file );
                return !empty( $list ); //empty list = no file, so invert.

-               // return $this->ftp->is_exists($file); has issues with ABOR+426 responses on the ncFTPd server
+               // Return $this->ftp->is_exists($file); has issues with ABOR+426 responses on the ncFTPd server.

        }
 
        }
 

-       function is_file($file) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_file($file) {

                if ( $this->is_dir($file) )
                        return false;
                if ( $this->exists($file) )
                if ( $this->is_dir($file) )
                        return false;
                if ( $this->exists($file) )


@@ -242,7 +301,11 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return false;
        }
 
                return false;
        }
 

-       function is_dir($path) {
+       /**
+        * @param string $path
+        * @return bool
+        */
+       public function is_dir($path) {

                $cwd = $this->cwd();
                if ( $this->chdir($path) ) {
                        $this->chdir($cwd);
                $cwd = $this->cwd();
                if ( $this->chdir($path) ) {
                        $this->chdir($cwd);


@@ -251,31 +314,63 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return false;
        }
 
                return false;
        }
 

-       function is_readable($file) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_readable($file) {

                return true;
        }
 
                return true;
        }
 

-       function is_writable($file) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function is_writable($file) {

                return true;
        }
 
                return true;
        }
 

-       function atime($file) {
+       /**
+        * @param string $file
+        * @return bool
+        */
+       public function atime($file) {

                return false;
        }
 
                return false;
        }
 

-       function mtime($file) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function mtime($file) {

                return $this->ftp->mdtm($file);
        }
 
                return $this->ftp->mdtm($file);
        }
 

-       function size($file) {
+       /**
+        * @param string $file
+        * @return int
+        */
+       public function size($file) {

                return $this->ftp->filesize($file);
        }
                return $this->ftp->filesize($file);
        }

-
-       function touch($file, $time = 0, $atime = 0 ) {
+       /**
+        * @param string $file
+        * @param int $time
+        * @param int $atime
+        * @return bool
+        */
+       public function touch($file, $time = 0, $atime = 0 ) {

                return false;
        }
 
                return false;
        }
 

-       function mkdir($path, $chmod = false, $chown = false, $chgrp = false ) {
+       /**
+        * @param string $path
+        * @param mixed $chmod
+        * @param mixed $chown
+        * @param mixed $chgrp
+        * @return bool
+        */
+       public function mkdir($path, $chmod = false, $chown = false, $chgrp = false ) {

                $path = untrailingslashit($path);
                if ( empty($path) )
                        return false;
                $path = untrailingslashit($path);
                if ( empty($path) )
                        return false;


@@ -292,11 +387,21 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return true;
        }
 
                return true;
        }
 

-       function rmdir($path, $recursive = false ) {
+       /**
+        * @param sting $path
+        * @param bool $recursive
+        */
+       public function rmdir($path, $recursive = false ) {

                $this->delete($path, $recursive);
        }
 
                $this->delete($path, $recursive);
        }
 

-       function dirlist($path = '.', $include_hidden = true, $recursive = false ) {
+       /**
+        * @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) ) {
                        $limit_file = basename($path);
                        $path = dirname($path) . '/';
                if ( $this->is_file($path) ) {
                        $limit_file = basename($path);
                        $path = dirname($path) . '/';


@@ -345,7 +450,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
                return $ret;
        }
 
                return $ret;
        }
 

-       function __destruct() {
+       public function __destruct() {

                $this->ftp->quit();
        }
 }
                $this->ftp->quit();
        }
 }