*/
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') . "<br/>\n", $newdir );
* 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() {
* 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;
* 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.
*/
* 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.
* 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() {
* 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.
*/
* 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.
* 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.
* 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.
*/
* 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.
*/
* 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.
* 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.
* 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.
* 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.
*/
* Check if resource is a file.
*
* @since 2.5.0
- *
+ * @abstract
* @param string $file File path.
* @return bool Whether $file is a file.
*/
* Check if resource is a directory.
*
* @since 2.5.0
- *
+ * @abstract
* @param string $path Directory path.
* @return bool Whether $path is a directory.
*/
* Check if a file is readable.
*
* @since 2.5.0
- *
+ * @abstract
* @param string $file Path to file.
* @return bool Whether $file is readable.
*/
* 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 ) {
* 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;
* 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;
* 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;
* 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.
* 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.
* 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.
* 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.
* @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 ) {
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff