Directories
Directories
- public static function createDirectory($path, $umask, $recursive) — Create a directory in a manner similar to mkdir(), but throw detailed exceptions on failure.
- public static function createTemporaryDirectory($prefix, $umask, $root_directory) — Create a temporary directory and return the path to it. You are responsible for removing it (e.g., with Filesystem::remove()) when you are done with it.
- public static function listDirectory($path, $include_hidden) — List files in a directory.
- public static function walkToRoot($path, $root) — Return all directories between a path and the specified root directory (defaulting to "/"). Iterating over them walks from the path to the root.
Files
Files
- public static function readFile($path) — Read a file in a manner similar to file_get_contents(), but throw detailed exceptions on failure.
- public static function writeFile($path, $data) — Write a file in a manner similar to file_put_contents(), but throw detailed exceptions on failure. If the file already exists, it will be overwritten.
- public static function writeUniqueFile($base, $data) — Write data to unique file, without overwriting existing files. This is useful if you want to write a ".bak" file or something similar, but want to make sure you don't overwrite something already on disk.
- public static function appendFile($path, $data) — Append to a file without having to deal with file handles, with detailed exceptions on failure.
- public static function copyFile($from, $to) — Copy a file, preserving file attributes (if relevant for the OS).
- public static function remove($path) — Remove a file or directory.
- public static function rename($old, $new) — Rename a file or directory.
- private static function executeRemovePath($path) — Internal. Recursively remove a file or an entire directory. Implements the core function of @{method:remove} in a way that works on Windows.
- public static function changePermissions($path, $umask) — Change the permissions of a file or directory.
- public static function getModifiedTime($path) — Get the last modified time of a file
- public static function readRandomBytes($number_of_bytes) — Read random bytes from /dev/urandom or equivalent. See also @{method:readRandomCharacters}.
- public static function readRandomCharacters($number_of_characters) — Read random alphanumeric characters from /dev/urandom or equivalent. This method operates like @{method:readRandomBytes} but produces alphanumeric output (a-z, 0-9) so it's appropriate for use in URIs and other contexts where it needs to be human readable.
- public static function getMimeType($path, $default) — Identify the MIME type of a file. This returns only the MIME type (like text/plain), not the encoding (like charset=utf-8).
Paths
Paths
- public static function resolvePath($path, $relative_to) — Canonicalize a path by resolving it relative to some directory (by default PWD), following parent symlinks and removing artifacts. If the path is itself a symlink it is left unresolved.
- public static function isDescendant($path, $root) — Test whether a path is descendant from some root path after resolving all symlinks and removing artifacts. Both paths must exists for the relation to obtain. A path is always a descendant of itself as long as it exists.
- public static function readablePath($path, $pwd) — Convert a canonical path to its most human-readable format. It is guaranteed that you can use resolvePath() to restore a path to its canonical format.
- public static function pathExists($path) — Determine whether or not a path exists in the filesystem. This differs from file_exists() in that it returns true for symlinks. This method does not attempt to resolve paths before testing them.
- public static function pathsAreEquivalent($u, $v) — Determine if two paths are equivalent by resolving symlinks. This is different from resolving both paths and comparing them because resolvePath() only resolves symlinks in parent directories, not the path itself.
Executables
Executables
- public static function binaryExists($binary) — Determine if an executable binary (like `git` or `svn`) exists within the configured `$PATH`.
- public static function resolveBinary($binary) — Locates the full path that an executable binary (like `git` or `svn`) is at the configured `$PATH`.
Assertions
Assertions
- public static function assertExists($path) — Assert that something (e.g., a file, directory, or symlink) exists at a specified location.
- public static function assertNotExists($path) — Assert that nothing exists at a specified location.
- public static function assertIsFile($path) — Assert that a path represents a file, strictly (i.e., not a directory).
- public static function assertIsDirectory($path) — Assert that a path represents a directory, strictly (i.e., not a file).
- public static function assertWritable($path) — Assert that a file or directory exists and is writable.
- public static function assertReadable($path) — Assert that a file or directory exists and is readable.
Other Methods
Other Methods
- public function __get($name)
- public function __set($name, $value)
- public function current()
- public function key()
- public function next()
- public function rewind()
- public function valid()
- private function throwOnAttemptedIteration()
- public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
- public static function assertWritableFile($path) — Make assertions about the state of path in preparation for writeFile() and writeFileIfChanged().
- public static function writeFileIfChanged($path, $data) — Write a file in a manner similar to `file_put_contents()`, but only touch the file if the contents are different, and throw detailed exceptions on failure.
- public static function readRandomInteger($min, $max) — Generate a random integer value in a given range.
- public static function isAbsolutePath($path) — Checks if a path is specified as an absolute path.
- public static function concatenatePaths($components)