X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..1132430022383fdf47fa6cb9377300fd885297aa:/wp-admin/includes/class-wp-filesystem-base.php diff --git a/wp-admin/includes/class-wp-filesystem-base.php b/wp-admin/includes/class-wp-filesystem-base.php index 4630f710..9b8ddb04 100644 --- a/wp-admin/includes/class-wp-filesystem-base.php +++ b/wp-admin/includes/class-wp-filesystem-base.php @@ -317,7 +317,7 @@ class WP_Filesystem_Base { */ if ( isset($files[ $key ]) ){ - // Lets try that folder: + // Let's try that folder: $newdir = trailingslashit(path_join($base, $key)); if ( $this->verbose ) printf( "\n" . __('Changing to %s') . "
\n", $newdir ); @@ -469,7 +469,7 @@ class WP_Filesystem_Base { * Connect filesystem. * * @since 2.5.0 - * + * @abstract * @return bool True on success or false on failure (always true for WP_Filesystem_Direct). */ public function connect() { @@ -480,9 +480,9 @@ class WP_Filesystem_Base { * Read entire file into a string. * * @since 2.5.0 - * + * @abstract * @param string $file Name of the file to read. - * @return string|bool Returns the read data or false on failure. + * @return mixed|bool Returns the read data or false on failure. */ public function get_contents( $file ) { return false; @@ -492,7 +492,7 @@ class WP_Filesystem_Base { * Read entire file into an array. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @return array|bool the file contents in an array or false on failure. */ @@ -504,7 +504,7 @@ class WP_Filesystem_Base { * Write a string to a file. * * @since 2.5.0 - * + * @abstract * @param string $file Remote path to the file where to write the data. * @param string $contents The data to write. * @param int $mode Optional. The file permissions as octal number, usually 0644. @@ -518,7 +518,7 @@ class WP_Filesystem_Base { * Get the current working directory. * * @since 2.5.0 - * + * @abstract * @return string|bool The current working directory on success, or false on failure. */ public function cwd() { @@ -529,7 +529,7 @@ class WP_Filesystem_Base { * Change current directory. * * @since 2.5.0 - * + * @abstract * @param string $dir The new current directory. * @return bool Returns true on success or false on failure. */ @@ -541,7 +541,7 @@ class WP_Filesystem_Base { * Change the file group. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @param mixed $group A group name or number. * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. @@ -555,7 +555,7 @@ class WP_Filesystem_Base { * Change filesystem permissions. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @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. @@ -569,7 +569,7 @@ class WP_Filesystem_Base { * Get the file owner. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @return string|bool Username of the user or false on error. */ @@ -581,7 +581,7 @@ class WP_Filesystem_Base { * Get the file's group. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @return string|bool The group or false on error. */ @@ -593,7 +593,7 @@ class WP_Filesystem_Base { * Copy a file. * * @since 2.5.0 - * + * @abstract * @param string $source Path to the source file. * @param string $destination Path to the destination file. * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists. @@ -610,7 +610,7 @@ class WP_Filesystem_Base { * Move a file. * * @since 2.5.0 - * + * @abstract * @param string $source Path to the source file. * @param string $destination Path to the destination file. * @param bool $overwrite Optional. Whether to overwrite the destination file if it exists. @@ -625,7 +625,7 @@ class WP_Filesystem_Base { * Delete a file or directory. * * @since 2.5.0 - * + * @abstract * @param string $file Path to the file. * @param bool $recursive Optional. If set True changes file group recursively. Defaults to False. * Default false. @@ -641,7 +641,7 @@ class WP_Filesystem_Base { * Check if a file or directory exists. * * @since 2.5.0 - * + * @abstract * @param string $file Path to file/directory. * @return bool Whether $file exists or not. */ @@ -653,7 +653,7 @@ class WP_Filesystem_Base { * Check if resource is a file. * * @since 2.5.0 - * + * @abstract * @param string $file File path. * @return bool Whether $file is a file. */ @@ -665,7 +665,7 @@ class WP_Filesystem_Base { * Check if resource is a directory. * * @since 2.5.0 - * + * @abstract * @param string $path Directory path. * @return bool Whether $path is a directory. */ @@ -677,7 +677,7 @@ class WP_Filesystem_Base { * Check if a file is readable. * * @since 2.5.0 - * + * @abstract * @param string $file Path to file. * @return bool Whether $file is readable. */ @@ -689,8 +689,7 @@ class WP_Filesystem_Base { * Check if a file or directory is writable. * * @since 2.5.0 - * - * @param string $path Path to file/directory. + * @abstract * @return bool Whether $file is writable. */ public function is_writable( $file ) { @@ -701,9 +700,9 @@ class WP_Filesystem_Base { * Gets the file's last access time. * * @since 2.5.0 - * + * @abstract * @param string $file Path to file. - * @return int Unix timestamp representing last access time. + * @return int|bool Unix timestamp representing last access time. */ public function atime( $file ) { return false; @@ -713,9 +712,9 @@ class WP_Filesystem_Base { * Gets the file modification time. * * @since 2.5.0 - * + * @abstract * @param string $file Path to file. - * @return int Unix timestamp representing modification time. + * @return int|bool Unix timestamp representing modification time. */ public function mtime( $file ) { return false; @@ -725,9 +724,9 @@ class WP_Filesystem_Base { * Gets the file size (in bytes). * * @since 2.5.0 - * + * @abstract * @param string $file Path to file. - * @return int Size of the file in bytes. + * @return int|bool Size of the file in bytes. */ public function size( $file ) { return false; @@ -739,7 +738,7 @@ class WP_Filesystem_Base { * Note: If $file doesn't exist, it will be created. * * @since 2.5.0 - * + * @abstract * @param string $file Path to file. * @param int $time Optional. Modified time to set for file. * Default 0. @@ -755,7 +754,7 @@ class WP_Filesystem_Base { * Create a directory. * * @since 2.5.0 - * + * @abstract * @param string $path Path for new directory. * @param mixed $chmod Optional. The permissions as octal number, (or False to skip chmod) * Default false. @@ -773,7 +772,7 @@ class WP_Filesystem_Base { * Delete a directory. * * @since 2.5.0 - * + * @abstract * @param string $path Path to directory. * @param bool $recursive Optional. Whether to recursively remove files/directories. * Default false. @@ -787,6 +786,7 @@ class WP_Filesystem_Base { * Get details for files in a directory or a specific file. * * @since 2.5.0 + * @abstract * * @param string $path Path to directory or file. * @param bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files. @@ -796,16 +796,16 @@ class WP_Filesystem_Base { * @return array|bool { * Array of files. False if unable to list directory contents. * - * @type string 'name' Name of the file/directory. - * @type string 'perms' *nix representation of permissions. - * @type int 'permsn' Octal representation of permissions. - * @type string 'owner' Owner name or ID. - * @type int 'size' Size of file in bytes. - * @type int 'lastmodunix' Last modified unix timestamp. - * @type mixed 'lastmod' Last modified month (3 letter) and day (without leading 0). - * @type int 'time' Last modified time. - * @type string 'type' Type of resource. 'f' for file, 'd' for directory. - * @type mixed 'files' If a directory and $recursive is true, contains another array of files. + * @type string $name Name of the file/directory. + * @type string $perms *nix representation of permissions. + * @type int $permsn Octal representation of permissions. + * @type string $owner Owner name or ID. + * @type int $size Size of file in bytes. + * @type int $lastmodunix Last modified unix timestamp. + * @type mixed $lastmod Last modified month (3 letter) and day (without leading 0). + * @type int $time Last modified time. + * @type string $type Type of resource. 'f' for file, 'd' for directory. + * @type mixed $files If a directory and $recursive is true, contains another array of files. * } */ public function dirlist( $path, $include_hidden = true, $recursive = false ) {