/**
* Cached list of local filepaths to mapped remote filepaths.
*
+ * @access public
* @since 2.7.0
* @var array
*/
*/
public $method = '';
+ /**
+ * @access public
+ * @var WP_Error
+ */
public $errors = null;
+ /**
+ * @access public
+ */
public $options = array();
/**
* @return string The location of the remote path.
*/
public function find_base_dir( $base = '.', $echo = false ) {
- _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
+ _deprecated_function(__FUNCTION__, '2.7.0', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
$this->verbose = $echo;
return $this->abspath();
}
* @return string The location of the remote path.
*/
public function get_base_dir( $base = '.', $echo = false ) {
- _deprecated_function(__FUNCTION__, '2.7', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
+ _deprecated_function(__FUNCTION__, '2.7.0', 'WP_Filesystem::abspath() or WP_Filesystem::wp_*_dir()' );
$this->verbose = $echo;
return $this->abspath();
}
*
* Expects Windows sanitized path.
*
+ * @access public
* @since 2.7.0
*
* @param string $folder The folder to locate.
$folder = untrailingslashit($folder);
- if ( $this->verbose )
- printf( "\n" . __('Looking for %1$s in %2$s') . "<br/>\n", $folder, $base );
+ if ( $this->verbose ) {
+ /* translators: 1: folder to locate, 2: folder to start searching from */
+ printf( "\n" . __( 'Looking for %1$s in %2$s' ) . "<br/>\n", $folder, $base );
+ }
$folder_parts = explode('/', $folder);
$folder_part_keys = array_keys( $folder_parts );
// Let's try that folder:
$newdir = trailingslashit(path_join($base, $key));
- if ( $this->verbose )
- printf( "\n" . __('Changing to %s') . "<br/>\n", $newdir );
+ if ( $this->verbose ) {
+ /* translators: %s: directory name */
+ printf( "\n" . __( 'Changing to %s' ) . "<br/>\n", $newdir );
+ }
// Only search for the remaining path tokens in the directory, not the full path again.
$newfolder = implode( '/', array_slice( $folder_parts, $index + 1 ) );
}
}
- // Only check this as a last resort, to prevent locating the incorrect install. All above procedures will fail quickly if this is the right branch to take.
+ // Only check this as a last resort, to prevent locating the incorrect install.
+ // All above procedures will fail quickly if this is the right branch to take.
if (isset( $files[ $last_path ] ) ) {
- if ( $this->verbose )
- printf( "\n" . __('Found %s') . "<br/>\n", $base . $last_path );
+ if ( $this->verbose ) {
+ /* translators: %s: directory name */
+ printf( "\n" . __( 'Found %s' ) . "<br/>\n", $base . $last_path );
+ }
return trailingslashit($base . $last_path);
}
*
* From the PHP documentation page for fileperms().
*
- * @link http://docs.php.net/fileperms
+ * @link https://secure.php.net/manual/en/function.fileperms.php
*
* @access public
* @since 2.5.0
/**
* Gets the permissions of the specified file or filepath in their octal format
*
+ * @access public
* @since 2.5.0
* @param string $file
* @return string the last 3 characters of the octal number
* Converts '-rw-r--r--' to 0644
* From "info at rvgate dot nl"'s comment on the PHP documentation for chmod()
*
- * @link http://docs.php.net/manual/en/function.chmod.php#49614
+ * @link https://secure.php.net/manual/en/function.chmod.php#49614
*
* @access public
* @since 2.5.0
/**
* Determine if the string provided contains binary characters.
*
+ * @access public
* @since 2.7.0
*
* @param string $text String to test against.
*
* Default behavior is to do nothing, override this in your subclass, if desired.
*
+ * @access public
* @since 2.5.0
*
* @param string $file Path to the file.
/**
* Connect filesystem.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Name of the file to read.
* @return mixed|bool Returns the read data or false on failure.
*/
/**
* Read entire file into an array.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @return string|bool The current working directory on success, or false on failure.
*/
public function cwd() {
/**
* Change current directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $dir The new current directory.
* @return bool|string
*/
/**
* Change the file group.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to the file.
* @return string|bool The group or false on error.
*/
/**
* Copy a file.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file File path.
* @return bool Whether $file is a file.
*/
/**
* Check if resource is a directory.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $path Directory path.
* @return bool Whether $path is a directory.
*/
/**
* Check if a file is readable.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
+ * @param string $file Path to file.
* @return bool Whether $file is writable.
*/
public function is_writable( $file ) {
/**
* Gets the file's last access time.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Unix timestamp representing last access time.
*/
/**
* Gets the file modification time.
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Unix timestamp representing modification time.
*/
/**
* Gets the file size (in bytes).
*
+ * @access public
* @since 2.5.0
* @abstract
+ *
* @param string $file Path to file.
* @return int|bool Size of the file in bytes.
*/
*
* Note: If $file doesn't exist, it will be created.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @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.
*
+ * @access public
* @since 2.5.0
* @abstract
*
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff