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

Props wenthemes.
Fixes #33725.


git-svn-id: https://develop.svn.wordpress.org/trunk@33984 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor
2015-09-10 01:20:58 +00:00
parent c5220e43f5
commit 89f4c471fa
5 changed files with 296 additions and 2 deletions
@@ -16,11 +16,13 @@
*/
class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
/**
* @access public
* @var ftp
*/
public $ftp;
/**
* @access public
*
* @param array $opt
*/
@@ -57,6 +59,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @return bool
*/
@@ -88,6 +91,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return false|string
*/
@@ -123,7 +128,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
unlink($temp);
return $contents;
}
/**
* @access public
*
* @param string $file
* @return array
*/
@@ -132,6 +140,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @param string $contents
* @param int|bool $mode
@@ -172,6 +182,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @return string
*/
@@ -183,6 +194,7 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
@@ -192,6 +204,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @param int|bool $mode
* @param bool $recursive
@@ -219,6 +233,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return string
*/
@@ -226,7 +242,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file);
return $dir[$file]['owner'];
}
/**
* @access public
*
* @param string $file
* @return string
*/
@@ -234,7 +253,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file);
return $dir[$file]['permsn'];
}
/**
* @access public
*
* @param string $file
* @return string
*/
@@ -242,7 +264,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
$dir = $this->dirlist($file);
return $dir[$file]['group'];
}
/**
* @access public
*
* @param string $source
* @param string $destination
* @param bool $overwrite
@@ -259,7 +284,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
return $this->put_contents($destination, $content, $mode);
}
/**
* @access public
*
* @param string $source
* @param string $destination
* @param bool $overwrite
@@ -268,7 +296,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
public function move($source, $destination, $overwrite = false ) {
return $this->ftp->rename($source, $destination);
}
/**
* @access public
*
* @param string $file
* @param bool $recursive
* @param string $type
@@ -286,6 +317,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
*/
@@ -301,6 +334,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
*/
@@ -313,6 +348,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $path
* @return bool
*/
@@ -326,6 +363,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
*/
@@ -334,6 +373,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
*/
@@ -342,6 +383,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return bool
*/
@@ -350,6 +393,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $file
* @return int
*/
@@ -364,7 +409,10 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
public function size($file) {
return $this->ftp->filesize($file);
}
/**
* @access public
*
* @param string $file
* @param int $time
* @param int $atime
@@ -375,6 +423,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $path
* @param mixed $chmod
* @param mixed $chown
@@ -395,6 +445,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $path
* @param bool $recursive
*/
@@ -403,6 +455,8 @@ class WP_Filesystem_ftpsockets extends WP_Filesystem_Base {
}
/**
* @access public
*
* @param string $path
* @param bool $include_hidden
* @param bool $recursive