| [ Index ] |
PHP Cross Reference of phpBB-3.3.12-deutsch |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 774 lines (30 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Filesystem:: (24 methods):
copy()
mkdir()
exists()
touch()
remove()
chmod()
chown()
chgrp()
rename()
isReadable()
symlink()
hardlink()
linkException()
readlink()
makePathRelative()
mirror()
isAbsolutePath()
tempnam()
dumpFile()
appendToFile()
toIterable()
getSchemeAndHierarchy()
box()
handleError()
Class: Filesystem - X-Ref
Provides basic utility to manipulate the file system.| copy($originFile, $targetFile, $overwriteNewerFiles = false) X-Ref |
| Copies a file. If the target file is older than the origin file, it's always overwritten. If the target file is newer, it is overwritten only when the $overwriteNewerFiles option is set to true. param: string $originFile The original filename param: string $targetFile The target filename param: bool $overwriteNewerFiles If true, target files newer than origin files are overwritten |
| mkdir($dirs, $mode = 0777) X-Ref |
| Creates a directory recursively. param: string|iterable $dirs The directory path param: int $mode The directory mode |
| exists($files) X-Ref |
| Checks the existence of files or directories. return: bool true if the file exists, false otherwise param: string|iterable $files A filename, an array of files, or a \Traversable instance to check |
| touch($files, $time = null, $atime = null) X-Ref |
| Sets access and modification time of file. param: string|iterable $files A filename, an array of files, or a \Traversable instance to create param: int|null $time The touch time as a Unix timestamp, if not supplied the current system time is used param: int|null $atime The access time as a Unix timestamp, if not supplied the current system time is used |
| remove($files) X-Ref |
| Removes files or directories. param: string|iterable $files A filename, an array of files, or a \Traversable instance to remove |
| chmod($files, $mode, $umask = 0000, $recursive = false) X-Ref |
| Change mode for an array of files or directories. param: string|iterable $files A filename, an array of files, or a \Traversable instance to change mode param: int $mode The new mode (octal) param: int $umask The mode mask (octal) param: bool $recursive Whether change the mod recursively or not |
| chown($files, $user, $recursive = false) X-Ref |
| Change the owner of an array of files or directories. param: string|iterable $files A filename, an array of files, or a \Traversable instance to change owner param: string|int $user A user name or number param: bool $recursive Whether change the owner recursively or not |
| chgrp($files, $group, $recursive = false) X-Ref |
| Change the group of an array of files or directories. param: string|iterable $files A filename, an array of files, or a \Traversable instance to change group param: string|int $group A group name or number param: bool $recursive Whether change the group recursively or not |
| rename($origin, $target, $overwrite = false) X-Ref |
| Renames a file or a directory. param: string $origin The origin filename or directory param: string $target The new filename or directory param: bool $overwrite Whether to overwrite the target if it already exists |
| isReadable($filename) X-Ref |
| Tells whether a file exists and is readable. return: bool param: string $filename Path to the file |
| symlink($originDir, $targetDir, $copyOnWindows = false) X-Ref |
| Creates a symbolic link or copy a directory. param: string $originDir The origin directory path param: string $targetDir The symbolic link name param: bool $copyOnWindows Whether to copy files if on Windows |
| hardlink($originFile, $targetFiles) X-Ref |
| Creates a hard link, or several hard links to a file. param: string $originFile The original file param: string|string[] $targetFiles The target file(s) |
| linkException($origin, $target, $linkType) X-Ref |
param: string $origin param: string $target param: string $linkType Name of the link type, typically 'symbolic' or 'hard' |
| readlink($path, $canonicalize = false) X-Ref |
| Resolves links in paths. With $canonicalize = false (default) - if $path does not exist or is not a link, returns null - if $path is a link, returns the next direct target of the link without considering the existence of the target With $canonicalize = true - if $path does not exist, returns null - if $path exists, returns its absolute fully resolved final version return: string|null param: string $path A filesystem path param: bool $canonicalize Whether or not to return a canonicalized path |
| makePathRelative($endPath, $startPath) X-Ref |
| Given an existing path, convert it to a path relative to a given starting path. return: string Path of target relative to starting path param: string $endPath Absolute path of target param: string $startPath Absolute path where traversal begins |
| mirror($originDir, $targetDir, \Traversable $iterator = null, $options = []) X-Ref |
| Mirrors a directory to another. Copies files and directories from the origin directory into the target directory. By default: - existing files in the target directory will be overwritten, except if they are newer (see the `override` option) - files in the target directory that do not exist in the source directory will not be deleted (see the `delete` option) param: string $originDir The origin directory param: string $targetDir The target directory param: \Traversable|null $iterator Iterator that filters which files and directories to copy, if null a recursive iterator is created param: array $options An array of boolean options |
| isAbsolutePath($file) X-Ref |
| Returns whether the file path is an absolute path. return: bool param: string $file A file path |
| tempnam($dir, $prefix) X-Ref |
| Creates a temporary file with support for custom stream wrappers. return: string The new temporary filename (with path), or throw an exception on failure param: string $dir The directory where the temporary filename will be created param: string $prefix The prefix of the generated temporary filename |
| dumpFile($filename, $content) X-Ref |
| Atomically dumps content into a file. param: string $filename The file to be written to param: string $content The data to write into the file |
| appendToFile($filename, $content) X-Ref |
| Appends content to an existing file. param: string $filename The file to which to append content param: string $content The content to append |
| toIterable($files) X-Ref |
return: array|\Traversable param: mixed $files |
| getSchemeAndHierarchy($filename) X-Ref |
| Gets a 2-tuple of scheme (may be null) and hierarchical part of a filename (e.g. file:///tmp -> [file, tmp]). return: array The filename scheme and hierarchical part param: string $filename The filename to be parsed |
| box($func) X-Ref |
return: mixed param: callable $func |
| handleError($type, $msg) X-Ref |
| Generated: Sun Jun 23 12:25:44 2024 | Cross-referenced by PHPXref 0.7.1 |