WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add `@access` docs to `class-wp-filesystem-*` files. 

Props wenthemes.
Fixes #33725.

Built from https://develop.svn.wordpress.org/trunk@33984


git-svn-id: http://core.svn.wordpress.org/trunk@33953 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-09-10 01:21:24 +00:00
parent 2736486f5a
commit b8c37073d8
6 changed files with 297 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
wp-admin/includes/class-wp-filesystem-base.php
View File

@ -24,6 +24,7 @@ class WP_Filesystem_Base {
/** /**
* Cached list of local filepaths to mapped remote filepaths. * Cached list of local filepaths to mapped remote filepaths.
* *
* @access public
* @since 2.7.0 * @since 2.7.0
* @var array * @var array
*/ */
@ -38,8 +39,14 @@ class WP_Filesystem_Base {
*/ */
public $method = ''; public $method = '';
/**
* @access public
*/
public $errors = null; public $errors = null;
/**
* @access public
*/
public $options = array(); public $options = array();
/** /**
@ -230,6 +237,7 @@ class WP_Filesystem_Base {
* *
* Expects Windows sanitized path. * Expects Windows sanitized path.
* *
* @access public
* @since 2.7.0 * @since 2.7.0
* *
* @param string $folder The folder to locate. * @param string $folder The folder to locate.
@ -354,6 +362,7 @@ class WP_Filesystem_Base {
/** /**
* Gets the permissions of the specified file or filepath in their octal format * Gets the permissions of the specified file or filepath in their octal format
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @param string $file * @param string $file
* @return string the last 3 characters of the octal number * @return string the last 3 characters of the octal number
@ -401,6 +410,7 @@ class WP_Filesystem_Base {
/** /**
* Determine if the string provided contains binary characters. * Determine if the string provided contains binary characters.
* *
* @access public
* @since 2.7.0 * @since 2.7.0
* *
* @param string $text String to test against. * @param string $text String to test against.
@ -415,6 +425,7 @@ class WP_Filesystem_Base {
* *
* Default behavior is to do nothing, override this in your subclass, if desired. * Default behavior is to do nothing, override this in your subclass, if desired.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* *
* @param string $file Path to the file. * @param string $file Path to the file.
@ -429,8 +440,10 @@ class WP_Filesystem_Base {
/** /**
* Connect filesystem. * Connect filesystem.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @return bool True on success or false on failure (always true for WP_Filesystem_Direct). * @return bool True on success or false on failure (always true for WP_Filesystem_Direct).
*/ */
public function connect() { public function connect() {
@ -440,8 +453,10 @@ class WP_Filesystem_Base {
/** /**
* Read entire file into a string. * Read entire file into a string.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Name of the file to read. * @param string $file Name of the file to read.
* @return mixed|bool Returns the read data or false on failure. * @return mixed|bool Returns the read data or false on failure.
*/ */
@ -452,8 +467,10 @@ class WP_Filesystem_Base {
/** /**
* Read entire file into an array. * Read entire file into an array.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return array|bool the file contents in an array or false on failure. * @return array|bool the file contents in an array or false on failure.
*/ */
@ -464,8 +481,10 @@ class WP_Filesystem_Base {
/** /**
* Write a string to a file. * Write a string to a file.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Remote path to the file where to write the data. * @param string $file Remote path to the file where to write the data.
* @param string $contents The data to write. * @param string $contents The data to write.
* @param int $mode Optional. The file permissions as octal number, usually 0644. * @param int $mode Optional. The file permissions as octal number, usually 0644.
@ -478,8 +497,10 @@ class WP_Filesystem_Base {
/** /**
* Get the current working directory. * Get the current working directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @return string|bool The current working directory on success, or false on failure. * @return string|bool The current working directory on success, or false on failure.
*/ */
public function cwd() { public function cwd() {
@ -489,8 +510,10 @@ class WP_Filesystem_Base {
/** /**
* Change current directory. * Change current directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $dir The new current directory. * @param string $dir The new current directory.
* @return bool|string * @return bool|string
*/ */
@ -501,8 +524,10 @@ class WP_Filesystem_Base {
/** /**
* Change the file group. * Change the file group.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param mixed $group A group name or number. * @param mixed $group A group name or number.
* @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False.
@ -515,8 +540,10 @@ class WP_Filesystem_Base {
/** /**
* Change filesystem permissions. * Change filesystem permissions.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param int $mode Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs. * @param int $mode Optional. The permissions as octal number, usually 0644 for files, 0755 for dirs.
* @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False.
@ -529,8 +556,10 @@ class WP_Filesystem_Base {
/** /**
* Get the file owner. * Get the file owner.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return string|bool Username of the user or false on error. * @return string|bool Username of the user or false on error.
*/ */
@ -541,8 +570,10 @@ class WP_Filesystem_Base {
/** /**
* Get the file's group. * Get the file's group.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return string|bool The group or false on error. * @return string|bool The group or false on error.
*/ */
@ -553,8 +584,10 @@ class WP_Filesystem_Base {
/** /**
* Copy a file. * Copy a file.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $source Path to the source file. * @param string $source Path to the source file.
* @param string $destination Path to the destination file. * @param string $destination Path to the destination file.
* @param bool $overwrite Optional. Whether to overwrite the destination file if it exists. * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
@ -570,8 +603,10 @@ class WP_Filesystem_Base {
/** /**
* Move a file. * Move a file.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $source Path to the source file. * @param string $source Path to the source file.
* @param string $destination Path to the destination file. * @param string $destination Path to the destination file.
* @param bool $overwrite Optional. Whether to overwrite the destination file if it exists. * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists.
@ -585,8 +620,10 @@ class WP_Filesystem_Base {
/** /**
* Delete a file or directory. * Delete a file or directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False.
* Default false. * Default false.
@ -601,8 +638,10 @@ class WP_Filesystem_Base {
/** /**
* Check if a file or directory exists. * Check if a file or directory exists.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file/directory. * @param string $file Path to file/directory.
* @return bool Whether $file exists or not. * @return bool Whether $file exists or not.
*/ */
@ -613,8 +652,10 @@ class WP_Filesystem_Base {
/** /**
* Check if resource is a file. * Check if resource is a file.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file File path. * @param string $file File path.
* @return bool Whether $file is a file. * @return bool Whether $file is a file.
*/ */
@ -625,8 +666,10 @@ class WP_Filesystem_Base {
/** /**
* Check if resource is a directory. * Check if resource is a directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $path Directory path. * @param string $path Directory path.
* @return bool Whether $path is a directory. * @return bool Whether $path is a directory.
*/ */
@ -637,8 +680,10 @@ class WP_Filesystem_Base {
/** /**
* Check if a file is readable. * Check if a file is readable.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file. * @param string $file Path to file.
* @return bool Whether $file is readable. * @return bool Whether $file is readable.
*/ */
@ -649,8 +694,10 @@ class WP_Filesystem_Base {
/** /**
* Check if a file or directory is writable. * Check if a file or directory is writable.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @return bool Whether $file is writable. * @return bool Whether $file is writable.
*/ */
public function is_writable( $file ) { public function is_writable( $file ) {
@ -660,8 +707,10 @@ class WP_Filesystem_Base {
/** /**
* Gets the file's last access time. * Gets the file's last access time.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file. * @param string $file Path to file.
* @return int|bool Unix timestamp representing last access time. * @return int|bool Unix timestamp representing last access time.
*/ */
@ -672,8 +721,10 @@ class WP_Filesystem_Base {
/** /**
* Gets the file modification time. * Gets the file modification time.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file. * @param string $file Path to file.
* @return int|bool Unix timestamp representing modification time. * @return int|bool Unix timestamp representing modification time.
*/ */
@ -684,8 +735,10 @@ class WP_Filesystem_Base {
/** /**
* Gets the file size (in bytes). * Gets the file size (in bytes).
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file. * @param string $file Path to file.
* @return int|bool Size of the file in bytes. * @return int|bool Size of the file in bytes.
*/ */
@ -698,8 +751,10 @@ class WP_Filesystem_Base {
* *
* Note: If $file doesn't exist, it will be created. * Note: If $file doesn't exist, it will be created.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $file Path to file. * @param string $file Path to file.
* @param int $time Optional. Modified time to set for file. * @param int $time Optional. Modified time to set for file.
* Default 0. * Default 0.
@ -714,8 +769,10 @@ class WP_Filesystem_Base {
/** /**
* Create a directory. * Create a directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $path Path for new directory. * @param string $path Path for new directory.
* @param mixed $chmod Optional. The permissions as octal number, (or False to skip chmod) * @param mixed $chmod Optional. The permissions as octal number, (or False to skip chmod)
* Default false. * Default false.
@ -732,8 +789,10 @@ class WP_Filesystem_Base {
/** /**
* Delete a directory. * Delete a directory.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
*
* @param string $path Path to directory. * @param string $path Path to directory.
* @param bool $recursive Optional. Whether to recursively remove files/directories. * @param bool $recursive Optional. Whether to recursively remove files/directories.
* Default false. * Default false.
@ -746,6 +805,7 @@ class WP_Filesystem_Base {
/** /**
* Get details for files in a directory or a specific file. * Get details for files in a directory or a specific file.
* *
* @access public
* @since 2.5.0 * @since 2.5.0
* @abstract * @abstract
* *

54
wp-admin/includes/class-wp-filesystem-direct.php
View File

@ -19,6 +19,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* constructor * constructor
* *
* @access public
*
* @param mixed $arg ignored argument * @param mixed $arg ignored argument
*/ */
public function __construct($arg) { public function __construct($arg) {
@ -29,6 +31,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Reads entire file into a string * Reads entire file into a string
* *
* @access public
*
* @param string $file Name of the file to read. * @param string $file Name of the file to read.
* @return string|bool The function returns the read data or false on failure. * @return string|bool The function returns the read data or false on failure.
*/ */
@ -39,6 +43,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Reads entire file into an array * Reads entire file into an array
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return array|bool the file contents in an array or false on failure. * @return array|bool the file contents in an array or false on failure.
*/ */
@ -49,6 +55,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Write a string to a file * Write a string to a file
* *
* @access public
*
* @param string $file Remote path to the file where to write the data. * @param string $file Remote path to the file where to write the data.
* @param string $contents The data to write. * @param string $contents The data to write.
* @param int $mode Optional. The file permissions as octal number, usually 0644. * @param int $mode Optional. The file permissions as octal number, usually 0644.
@ -81,6 +89,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Gets the current working directory * Gets the current working directory
* *
* @access public
*
* @return string|bool the current working directory on success, or false on failure. * @return string|bool the current working directory on success, or false on failure.
*/ */
public function cwd() { public function cwd() {
@ -90,6 +100,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Change directory * Change directory
* *
* @access public
*
* @param string $dir The new current directory. * @param string $dir The new current directory.
* @return bool Returns true on success or false on failure. * @return bool Returns true on success or false on failure.
*/ */
@ -100,6 +112,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Changes file group * Changes file group
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param mixed $group A group name or number. * @param mixed $group A group name or number.
* @param bool $recursive Optional. If set True changes file group recursively. Default false. * @param bool $recursive Optional. If set True changes file group recursively. Default false.
@ -124,6 +138,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Changes filesystem permissions * Changes filesystem permissions
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param int $mode Optional. The permissions as octal number, usually 0644 for files, * @param int $mode Optional. The permissions as octal number, usually 0644 for files,
* 0755 for dirs. Default false. * 0755 for dirs. Default false.
@ -154,6 +170,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Changes file owner * Changes file owner
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @param mixed $owner A user name or number. * @param mixed $owner A user name or number.
* @param bool $recursive Optional. If set True changes file owner recursively. * @param bool $recursive Optional. If set True changes file owner recursively.
@ -178,6 +196,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
/** /**
* Gets file owner * Gets file owner
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return string|bool Username of the user or false on error. * @return string|bool Username of the user or false on error.
*/ */
@ -196,6 +216,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
* *
* FIXME does not handle errors in fileperms() * FIXME does not handle errors in fileperms()
* *
* @access public
*
* @param string $file Path to the file. * @param string $file Path to the file.
* @return string Mode of the file (last 3 digits). * @return string Mode of the file (last 3 digits).
*/ */
@ -204,6 +226,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string|false * @return string|false
*/ */
@ -218,6 +242,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -235,6 +261,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -257,6 +285,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param bool $recursive * @param bool $recursive
* @param string $type * @param string $type
@ -290,6 +320,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
return $retval; return $retval;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -297,6 +329,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
return @file_exists($file); return @file_exists($file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -304,6 +338,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
return @is_file($file); return @is_file($file);
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
@ -312,6 +348,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -320,6 +358,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -328,6 +368,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -336,6 +378,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -344,6 +388,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -352,6 +398,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int $time * @param int $time
* @param int $atime * @param int $atime
@ -366,6 +414,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param mixed $chmod * @param mixed $chmod
* @param mixed $chown * @param mixed $chown
@ -392,6 +442,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $recursive * @param bool $recursive
* @return bool * @return bool
@ -401,6 +453,8 @@ class WP_Filesystem_Direct extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $include_hidden * @param bool $include_hidden
* @param bool $recursive * @param bool $recursive

62
wp-admin/includes/class-wp-filesystem-ftpext.php
View File

@ -18,6 +18,7 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
public $link; public $link;
/** /**
* @access public
* *
* @param array $opt * @param array $opt
*/ */
@ -63,6 +64,7 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @return bool * @return bool
*/ */
@ -91,6 +93,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return false|string * @return false|string
*/ */
@ -116,6 +120,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return array * @return array
*/ */
@ -124,6 +130,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param string $contents * @param string $contents
* @param bool|int $mode * @param bool|int $mode
@ -161,6 +169,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @return string * @return string
*/ */
public function cwd() { public function cwd() {
@ -171,6 +181,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $dir * @param string $dir
* @return bool * @return bool
*/ */
@ -179,6 +191,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int $mode * @param int $mode
* @param bool $recursive * @param bool $recursive
@ -208,6 +222,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -216,6 +232,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
return $dir[$file]['owner']; return $dir[$file]['owner'];
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -223,7 +241,10 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
$dir = $this->dirlist($file); $dir = $this->dirlist($file);
return $dir[$file]['permsn']; return $dir[$file]['permsn'];
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -233,6 +254,7 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @param string $source * @param string $source
* @param string $destination * @param string $destination
@ -248,7 +270,10 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
return false; return false;
return $this->put_contents($destination, $content, $mode); return $this->put_contents($destination, $content, $mode);
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -257,7 +282,10 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
public function move($source, $destination, $overwrite = false) { public function move($source, $destination, $overwrite = false) {
return ftp_rename($this->link, $source, $destination); return ftp_rename($this->link, $source, $destination);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param bool $recursive * @param bool $recursive
* @param string $type * @param string $type
@ -277,7 +305,10 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
$this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] ); $this->delete( trailingslashit($file) . $delete_file['name'], $recursive, $delete_file['type'] );
return @ftp_rmdir($this->link, $file); return @ftp_rmdir($this->link, $file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -290,14 +321,20 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
return !empty($list); //empty list = no file, so invert. return !empty($list); //empty list = no file, so invert.
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
public function is_file($file) { public function is_file($file) {
return $this->exists($file) && !$this->is_dir($file); return $this->exists($file) && !$this->is_dir($file);
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
@ -312,41 +349,58 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
public function is_readable($file) { public function is_readable($file) {
return true; return true;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
public function is_writable($file) { public function is_writable($file) {
return true; return true;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
public function atime($file) { public function atime($file) {
return false; return false;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
public function mtime($file) { public function mtime($file) {
return ftp_mdtm($this->link, $file); return ftp_mdtm($this->link, $file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
public function size($file) { public function size($file) {
return ftp_size($this->link, $file); return ftp_size($this->link, $file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -355,6 +409,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param mixed $chmod * @param mixed $chmod
* @param mixed $chown * @param mixed $chown
@ -373,6 +429,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $recursive * @param bool $recursive
* @return bool * @return bool
@ -382,6 +440,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @staticvar bool $is_windows * @staticvar bool $is_windows
* @param string $line * @param string $line
* @return array * @return array
@ -461,6 +521,8 @@ class WP_Filesystem_FTPext extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $include_hidden * @param bool $include_hidden
* @param bool $recursive * @param bool $recursive

54
wp-admin/includes/class-wp-filesystem-ftpsockets.php
View File

@ -16,11 +16,13 @@
*/ */
class WP_Filesystem_ftpsockets extends WP_Filesystem_Base { class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
/** /**
* @access public
* @var ftp * @var ftp
*/ */
public $ftp; public $ftp;
/** /**
* @access public
* *
* @param array $opt * @param array $opt
*/ */
@ -57,6 +59,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @return bool * @return bool
*/ */
@ -88,6 +91,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return false|string * @return false|string
*/ */
@ -123,7 +128,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
unlink($temp); unlink($temp);
return $contents; return $contents;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return array * @return array
*/ */
@ -132,6 +140,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param string $contents * @param string $contents
* @param int|bool $mode * @param int|bool $mode
@ -172,6 +182,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @return string * @return string
*/ */
@ -183,6 +194,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @param string $file * @param string $file
* @return bool * @return bool
@ -192,6 +204,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int|bool $mode * @param int|bool $mode
* @param bool $recursive * @param bool $recursive
@ -219,6 +233,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -226,7 +242,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file); $dir = $this->dirlist($file);
return $dir[$file]['owner']; return $dir[$file]['owner'];
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -234,7 +253,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file); $dir = $this->dirlist($file);
return $dir[$file]['permsn']; return $dir[$file]['permsn'];
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -242,7 +264,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file); $dir = $this->dirlist($file);
return $dir[$file]['group']; return $dir[$file]['group'];
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -259,7 +284,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
return $this->put_contents($destination, $content, $mode); return $this->put_contents($destination, $content, $mode);
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -268,7 +296,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
public function move($source, $destination, $overwrite = false ) { public function move($source, $destination, $overwrite = false ) {
return $this->ftp->rename($source, $destination); return $this->ftp->rename($source, $destination);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param bool $recursive * @param bool $recursive
* @param string $type * @param string $type
@ -286,6 +317,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -301,6 +334,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -313,6 +348,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
@ -326,6 +363,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -334,6 +373,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -342,6 +383,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -350,6 +393,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -364,7 +409,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
public function size($file) { public function size($file) {
return $this->ftp->filesize($file); return $this->ftp->filesize($file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int $time * @param int $time
* @param int $atime * @param int $atime
@ -375,6 +423,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param mixed $chmod * @param mixed $chmod
* @param mixed $chown * @param mixed $chown
@ -395,6 +445,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $recursive * @param bool $recursive
*/ */
@ -403,6 +455,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $include_hidden * @param bool $include_hidden
* @param bool $recursive * @param bool $recursive

68
wp-admin/includes/class-wp-filesystem-ssh2.php
View File

@ -35,14 +35,20 @@
*/ */
class WP_Filesystem_SSH2 extends WP_Filesystem_Base { class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
public $link = false;
/** /**
* @access public
*/
public $link = false;
/**
* @access public
* @var resource * @var resource
*/ */
public $sftp_link; public $sftp_link;
public $keys = false; public $keys = false;
/** /**
* @access public
* *
* @param array $opt * @param array $opt
*/ */
@ -96,6 +102,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @return bool * @return bool
*/ */
@ -129,6 +136,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $command * @param string $command
* @param bool $returnbool * @param bool $returnbool
* @return bool|string * @return bool|string
@ -154,6 +163,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string|false * @return string|false
*/ */
@ -163,6 +174,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return array * @return array
*/ */
@ -172,6 +185,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param string $contents * @param string $contents
* @param bool|int $mode * @param bool|int $mode
@ -189,6 +204,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
* *
* @return bool * @return bool
*/ */
@ -201,6 +217,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $dir * @param string $dir
* @return bool|string * @return bool|string
*/ */
@ -209,6 +227,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param string $group * @param string $group
* @param bool $recursive * @param bool $recursive
@ -224,6 +244,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int $mode * @param int $mode
* @param bool $recursive * @param bool $recursive
@ -250,7 +272,7 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
/** /**
* Change the ownership of a file / folder. * Change the ownership of a file / folder.
* *
* @since Unknown * @access public
* *
* @param string $file Path to the file. * @param string $file Path to the file.
* @param string|int $owner A user name or number. * @param string|int $owner A user name or number.
@ -266,6 +288,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string|false * @return string|false
*/ */
@ -278,7 +302,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
$ownerarray = posix_getpwuid($owneruid); $ownerarray = posix_getpwuid($owneruid);
return $ownerarray['name']; return $ownerarray['name'];
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string * @return string
*/ */
@ -287,6 +314,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return string|false * @return string|false
*/ */
@ -301,6 +330,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -317,6 +348,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $source * @param string $source
* @param string $destination * @param string $destination
* @param bool $overwrite * @param bool $overwrite
@ -327,6 +360,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param bool $recursive * @param bool $recursive
* @param string|bool $type * @param string|bool $type
@ -347,6 +382,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -354,7 +391,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
$file = ltrim($file, '/'); $file = ltrim($file, '/');
return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file); return file_exists('ssh2.sftp://' . $this->sftp_link . '/' . $file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -362,7 +402,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
$file = ltrim($file, '/'); $file = ltrim($file, '/');
return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file); return is_file('ssh2.sftp://' . $this->sftp_link . '/' . $file);
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
@ -370,7 +413,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
$path = ltrim($path, '/'); $path = ltrim($path, '/');
return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path); return is_dir('ssh2.sftp://' . $this->sftp_link . '/' . $path);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -378,7 +424,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
$file = ltrim($file, '/'); $file = ltrim($file, '/');
return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file); return is_readable('ssh2.sftp://' . $this->sftp_link . '/' . $file);
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return bool * @return bool
*/ */
@ -386,7 +435,10 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
// PHP will base it's writable checks on system_user === file_owner, not ssh_user === file_owner // PHP will base it's writable checks on system_user === file_owner, not ssh_user === file_owner
return true; return true;
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -396,6 +448,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -405,6 +459,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @return int * @return int
*/ */
@ -414,6 +470,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $file * @param string $file
* @param int $time * @param int $time
* @param int $atime * @param int $atime
@ -423,6 +481,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param mixed $chmod * @param mixed $chmod
* @param mixed $chown * @param mixed $chown
@ -446,6 +506,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $recursive * @param bool $recursive
* @return bool * @return bool
@ -455,6 +517,8 @@ class WP_Filesystem_SSH2 extends WP_Filesystem_Base {
} }
/** /**
* @access public
*
* @param string $path * @param string $path
* @param bool $include_hidden * @param bool $include_hidden
* @param bool $recursive * @param bool $recursive

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-33983'; $wp_version = '4.4-alpha-33984';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.