类文件系统
这提供了一些围绕常见文件系统查询的便捷包装器。
这是一个内部辅助类,不应在应用程序代码中使用,因为它不保证兼容性。
命名空间: Cake\Utility
常量
-
字符串
TYPE_DIR ¶'dir'
目录类型常量
方法摘要
-
copyDir() public
复制包含所有内容的目录。
-
deleteDir() public
删除目录及其所有内容。
-
dumpFile() public
将内容转储到文件。
-
filterIterator() protected
将迭代器包装在附加的过滤迭代器中。
-
find() public
在给定的目录路径中查找文件/目录(非递归)。
-
findRecursive() public
在给定的目录路径中递归查找文件/目录。
-
isStream() public
检查给定路径是否为流路径。
-
mkdir() public
创建目录。
方法详情
copyDir() ¶ public
copyDir(string $source, string $destination): bool
复制包含所有内容的目录。
参数
-
string
$source 源路径。
-
string
$destination 目标路径。
返回值
bool
deleteDir() ¶ public
deleteDir(string $path): bool
删除目录及其所有内容。
参数
-
string
$path 目录路径。
返回值
bool
抛出
Cake\Core\Exception\CakeException
如果路径不是目录。
dumpFile() ¶ public
dumpFile(string $filename, string $content): void
将内容转储到文件。
参数
-
string
$filename 文件路径。
-
string
$content 要转储的内容。
返回值
void
抛出
Cake\Core\Exception\CakeException
当转储失败时。
filterIterator() ¶ protected
filterIterator(Iterator $iterator, Closure|string $filter): Iterator
将迭代器包装在附加的过滤迭代器中。
参数
-
Iterator
$iterator 迭代器
-
Closure|string
$filter 正则表达式字符串或回调。
返回值
迭代器
find() ¶ public
find(string $path, Closure|string|null $filter = null, int|null $flags = null): Iterator
在给定的目录路径中查找文件/目录(非递归)。
参数
-
string
$path 目录路径。
-
Closure|string|null
$filter optional 如果字符串将用作使用
RegexIterator
过滤的正则表达式,如果可调用将用作CallbackFilterIterator
的回调。-
int|null
$flags optional FilesystemIterator::__construct() 的标志。
返回值
迭代器
findRecursive() ¶ public
findRecursive(string $path, Closure|string|null $filter = null, int|null $flags = null): Iterator
在给定的目录路径中递归查找文件/目录。
参数
-
string
$path 目录路径。
-
Closure|string|null
$filter optional 如果字符串将用作使用
RegexIterator
过滤的正则表达式,如果可调用将用作CallbackFilterIterator
的回调。隐藏目录(以点开头,例如 .git)始终被跳过。-
int|null
$flags optional FilesystemIterator::__construct() 的标志。
返回值
迭代器
mkdir() ¶ public
mkdir(string $dir, int $mode = 0755): void
创建目录。
参数
-
string
$dir 目录路径。
-
int
$mode optional 传递给 mkdir() 的八进制模式。默认为 0755。
返回值
void
抛出
Cake\Core\Exception\CakeException
当目录创建失败时。