WordPress 4.0
[autoinstalls/wordpress.git] / wp-admin / includes / class-wp-filesystem-base.php
index c471b54fda099afaa28959c75ad658582936d8b3..4630f710ea7cda4e3b2d7a2c590f792889c1192e 100644 (file)
@@ -19,7 +19,7 @@ class WP_Filesystem_Base {
         * @since 2.5.0
         * @var bool
         */
-       var $verbose = false;
+       public $verbose = false;
 
        /**
         * Cached list of local filepaths to mapped remote filepaths.
@@ -28,7 +28,7 @@ class WP_Filesystem_Base {
         * @since 2.7.0
         * @var array
         */
-       var $cache = array();
+       private $cache = array();
 
        /**
         * The Access method of the current connection, Set automatically.
@@ -37,12 +37,59 @@ class WP_Filesystem_Base {
         * @since 2.5.0
         * @var string
         */
-       var $method = '';
+       public $method = '';
 
        /**
-        * Constructor (empty).
+        * Make private properties readable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to get.
+        * @return mixed Property.
+        */
+       public function __get( $name ) {
+               return $this->$name;
+       }
+
+       /**
+        * Make private properties settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name  Property to set.
+        * @param mixed  $value Property value.
+        * @return mixed Newly-set property.
         */
-       function __construct() {}
+       public function __set( $name, $value ) {
+               return $this->$name = $value;
+       }
+
+       /**
+        * Make private properties checkable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to check if set.
+        * @return bool Whether the property is set.
+        */
+       public function __isset( $name ) {
+               return isset( $this->$name );
+       }
+
+       /**
+        * Make private properties un-settable for backwards compatibility.
+        *
+        * @since 4.0.0
+        * @access public
+        *
+        * @param string $name Property to unset.
+        */
+       public function __unset( $name ) {
+               unset( $this->$name );
+       }
 
        /**
         * Return the path on the remote filesystem of ABSPATH.
@@ -52,10 +99,10 @@ class WP_Filesystem_Base {
         *
         * @return string The location of the remote path.
         */
-       function abspath() {
+       public function abspath() {
                $folder = $this->find_folder(ABSPATH);
                // Perhaps the FTP folder is rooted at the WordPress install, Check for wp-includes folder in root, Could have some false positives, but rare.
-               if ( ! $folder && $this->is_dir('/wp-includes') )
+               if ( ! $folder && $this->is_dir( '/' . WPINC ) )
                        $folder = '/';
                return $folder;
        }
@@ -68,7 +115,7 @@ class WP_Filesystem_Base {
         *
         * @return string The location of the remote path.
         */
-       function wp_content_dir() {
+       public function wp_content_dir() {
                return $this->find_folder(WP_CONTENT_DIR);
        }
 
@@ -80,7 +127,7 @@ class WP_Filesystem_Base {
         *
         * @return string The location of the remote path.
         */
-       function wp_plugins_dir() {
+       public function wp_plugins_dir() {
                return $this->find_folder(WP_PLUGIN_DIR);
        }
 
@@ -93,7 +140,7 @@ class WP_Filesystem_Base {
         * @param string $theme The Theme stylesheet or template for the directory.
         * @return string The location of the remote path.
         */
-       function wp_themes_dir( $theme = false ) {
+       public function wp_themes_dir( $theme = false ) {
                $theme_root = get_theme_root( $theme );
 
                // Account for relative theme roots
@@ -111,7 +158,7 @@ class WP_Filesystem_Base {
         *
         * @return string The location of the remote path.
         */
-       function wp_lang_dir() {
+       public function wp_lang_dir() {
                return $this->find_folder(WP_LANG_DIR);
        }
 
@@ -132,7 +179,7 @@ class WP_Filesystem_Base {
         *                     Default false.
         * @return string The location of the remote path.
         */
-       function find_base_dir( $base = '.', $echo = false ) {
+       public function find_base_dir( $base = '.', $echo = false ) {
                _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
                $this->verbose = $echo;
                return $this->abspath();
@@ -154,7 +201,7 @@ class WP_Filesystem_Base {
         * @param bool   $echo True to display debug information.
         * @return string The location of the remote path.
         */
-       function get_base_dir( $base = '.', $echo = false ) {
+       public function get_base_dir( $base = '.', $echo = false ) {
                _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
                $this->verbose = $echo;
                return $this->abspath();
@@ -172,7 +219,7 @@ class WP_Filesystem_Base {
         * @param string $folder the folder to locate.
         * @return string The location of the remote path.
         */
-       function find_folder( $folder ) {
+       public function find_folder( $folder ) {
 
                if ( isset( $this->cache[ $folder ] ) )
                        return $this->cache[ $folder ];
@@ -241,7 +288,7 @@ class WP_Filesystem_Base {
         * @param bool   $loop   If the function has recursed, Internal use only.
         * @return string The location of the remote path.
         */
-       function search_for_folder( $folder, $base = '.', $loop = false ) {
+       public function search_for_folder( $folder, $base = '.', $loop = false ) {
                if ( empty( $base ) || '.' == $base )
                        $base = trailingslashit($this->cwd());
 
@@ -261,16 +308,21 @@ class WP_Filesystem_Base {
                        if ( $index == $last_index )
                                continue; // We want this to be caught by the next code block.
 
-                       // Working from /home/ to /user/ to /wordpress/ see if that file exists within the current folder,
-                       // If it's found, change into it and follow through looking for it.
-                       // If it cant find WordPress down that route, it'll continue onto the next folder level, and see if that matches, and so on.
-                       // If it reaches the end, and still cant find it, it'll return false for the entire function.
+                       /*
+                        * Working from /home/ to /user/ to /wordpress/ see if that file exists within
+                        * the current folder, If it's found, change into it and follow through looking
+                        * for it. If it cant find WordPress down that route, it'll continue onto the next
+                        * folder level, and see if that matches, and so on. If it reaches the end, and still
+                        * cant find it, it'll return false for the entire function.
+                        */
                        if ( isset($files[ $key ]) ){
+
                                // Lets try that folder:
                                $newdir = trailingslashit(path_join($base, $key));
                                if ( $this->verbose )
                                        printf( "\n" . __('Changing to %s') . "<br/>\n", $newdir );
-                               // only search for the remaining path tokens in the directory, not the full path again
+
+                               // Only search for the remaining path tokens in the directory, not the full path again.
                                $newfolder = implode( '/', array_slice( $folder_parts, $index + 1 ) );
                                if ( $ret = $this->search_for_folder( $newfolder, $newdir, $loop) )
                                        return $ret;
@@ -308,7 +360,7 @@ class WP_Filesystem_Base {
         * @param string $file String filename.
         * @return string The *nix-style representation of permissions.
         */
-       function gethchmod( $file ){
+       public function gethchmod( $file ){
                $perms = $this->getchmod($file);
                if (($perms & 0xC000) == 0xC000) // Socket
                        $info = 's';
@@ -364,7 +416,7 @@ class WP_Filesystem_Base {
         * @param string $mode string The *nix-style file permission.
         * @return int octal representation
         */
-       function getnumchmodfromh( $mode ) {
+       public function getnumchmodfromh( $mode ) {
                $realmode = '';
                $legal =  array('', 'w', 'r', 'x', '-');
                $attarray = preg_split('//', $mode);
@@ -393,7 +445,7 @@ class WP_Filesystem_Base {
         * @param string $text String to test against.
         * @return bool true if string is binary, false otherwise.
         */
-       function is_binary( $text ) {
+       public function is_binary( $text ) {
                return (bool) preg_match( '|[^\x20-\x7E]|', $text ); // chr(32)..chr(127)
        }
 
@@ -409,7 +461,7 @@ class WP_Filesystem_Base {
         * @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 ) {
+       public function chown( $file, $owner, $recursive = false ) {
                return false;
        }
 
@@ -420,7 +472,7 @@ class WP_Filesystem_Base {
         *
         * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
         */
-       function connect() {
+       public function connect() {
                return true;
        }
 
@@ -432,7 +484,7 @@ class WP_Filesystem_Base {
         * @param string $file Name of the file to read.
         * @return string|bool Returns the read data or false on failure.
         */
-       function get_contents( $file ) {
+       public function get_contents( $file ) {
                return false;
        }
 
@@ -444,7 +496,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to the file.
         * @return array|bool the file contents in an array or false on failure.
         */
-       function get_contents_array( $file ) {
+       public function get_contents_array( $file ) {
                return false;
        }
 
@@ -458,7 +510,7 @@ class WP_Filesystem_Base {
         * @param int    $mode     Optional. The file permissions as octal number, usually 0644.
         * @return bool False on failure.
         */
-       function put_contents( $file, $contents, $mode = false ) {
+       public function put_contents( $file, $contents, $mode = false ) {
                return false;
        }
 
@@ -469,7 +521,7 @@ class WP_Filesystem_Base {
         *
         * @return string|bool The current working directory on success, or false on failure.
         */
-       function cwd() {
+       public function cwd() {
                return false;
        }
 
@@ -481,7 +533,7 @@ class WP_Filesystem_Base {
         * @param string $dir The new current directory.
         * @return bool Returns true on success or false on failure.
         */
-       function chdir( $dir ) {
+       public function chdir( $dir ) {
                return false;
        }
 
@@ -495,7 +547,7 @@ class WP_Filesystem_Base {
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         * @return bool Returns true on success or false on failure.
         */
-       function chgrp( $file, $group, $recursive = false ) {
+       public function chgrp( $file, $group, $recursive = false ) {
                return false;
        }
 
@@ -509,7 +561,7 @@ class WP_Filesystem_Base {
         * @param bool   $recursive Optional. If set True changes file group recursively. Defaults to False.
         * @return bool Returns true on success or false on failure.
         */
-       function chmod( $file, $mode = false, $recursive = false ) {
+       public function chmod( $file, $mode = false, $recursive = false ) {
                return false;
        }
 
@@ -521,7 +573,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to the file.
         * @return string|bool Username of the user or false on error.
         */
-       function owner( $file ) {
+       public function owner( $file ) {
                return false;
        }
 
@@ -533,7 +585,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to the file.
         * @return string|bool The group or false on error.
         */
-       function group( $file ) {
+       public function group( $file ) {
                return false;
        }
 
@@ -550,7 +602,7 @@ class WP_Filesystem_Base {
         *                            Default false.
         * @return bool True if file copied successfully, False otherwise.
         */
-       function copy( $source, $destination, $overwrite = false, $mode = false ) {
+       public function copy( $source, $destination, $overwrite = false, $mode = false ) {
                return false;
        }
 
@@ -565,7 +617,7 @@ class WP_Filesystem_Base {
         *                            Default false.
         * @return bool True if file copied successfully, False otherwise.
         */
-       function move( $source, $destination, $overwrite = false ) {
+       public function move( $source, $destination, $overwrite = false ) {
                return false;
        }
 
@@ -581,7 +633,7 @@ class WP_Filesystem_Base {
         *                          Default false.
         * @return bool True if the file or directory was deleted, false on failure.
         */
-       function delete( $file, $recursive = false, $type = false ) {
+       public function delete( $file, $recursive = false, $type = false ) {
                return false;
        }
 
@@ -593,7 +645,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to file/directory.
         * @return bool Whether $file exists or not.
         */
-       function exists( $file ) {
+       public function exists( $file ) {
                return false;
        }
 
@@ -605,7 +657,7 @@ class WP_Filesystem_Base {
         * @param string $file File path.
         * @return bool Whether $file is a file.
         */
-       function is_file( $file ) {
+       public function is_file( $file ) {
                return false;
        }
 
@@ -617,7 +669,7 @@ class WP_Filesystem_Base {
         * @param string $path Directory path.
         * @return bool Whether $path is a directory.
         */
-       function is_dir( $path ) {
+       public function is_dir( $path ) {
                return false;
        }
 
@@ -629,7 +681,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to file.
         * @return bool Whether $file is readable.
         */
-       function is_readable( $file ) {
+       public function is_readable( $file ) {
                return false;
        }
 
@@ -641,7 +693,7 @@ class WP_Filesystem_Base {
         * @param string $path Path to file/directory.
         * @return bool Whether $file is writable.
         */
-       function is_writable( $file ) {
+       public function is_writable( $file ) {
                return false;
        }
 
@@ -653,7 +705,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to file.
         * @return int Unix timestamp representing last access time.
         */
-       function atime( $file ) {
+       public function atime( $file ) {
                return false;
        }
 
@@ -665,7 +717,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to file.
         * @return int Unix timestamp representing modification time.
         */
-       function mtime( $file ) {
+       public function mtime( $file ) {
                return false;
        }
 
@@ -677,7 +729,7 @@ class WP_Filesystem_Base {
         * @param string $file Path to file.
         * @return int Size of the file in bytes.
         */
-       function size( $file ) {
+       public function size( $file ) {
                return false;
        }
 
@@ -695,7 +747,7 @@ class WP_Filesystem_Base {
         *                      Default 0.
         * @return bool Whether operation was successful or not.
         */
-       function touch( $file, $time = 0, $atime = 0 ) {
+       public function touch( $file, $time = 0, $atime = 0 ) {
                return false;
        }
 
@@ -713,7 +765,7 @@ class WP_Filesystem_Base {
         *                      Default false.
         * @return bool False if directory cannot be created, true otherwise.
         */
-       function mkdir( $path, $chmod = false, $chown = false, $chgrp = false ) {
+       public function mkdir( $path, $chmod = false, $chown = false, $chgrp = false ) {
                return false;
        }
 
@@ -727,7 +779,7 @@ class WP_Filesystem_Base {
         *                          Default false.
         * @return bool Whether directory is deleted successfully or not.
         */
-       function rmdir( $path, $recursive = false ) {
+       public function rmdir( $path, $recursive = false ) {
                return false;
        }
 
@@ -756,7 +808,7 @@ class WP_Filesystem_Base {
         *     @type mixed  'files'       If a directory and $recursive is true, contains another array of files.
         * }
         */
-       function dirlist( $path, $include_hidden = true, $recursive = false ) {
+       public function dirlist( $path, $include_hidden = true, $recursive = false ) {
                return false;
        }