Класс Filesystem
Это предоставляет удобные обертки вокруг общих запросов к файловой системе.
Это внутренний вспомогательный класс, который не следует использовать в прикладном коде, так как он не гарантирует совместимости.
Константы
-
stringTYPE_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 Путь к каталогу назначения.
Возвращает
booldeleteDir() 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, mixed $filter): Iterator
Оборачивает итератор дополнительным фильтрующим итератором.
Параметры
-
Iterator$iterator Итератор
-
mixed$filter Строка регулярного выражения или обратный вызов.
Возвращает
Iteratorfind() public
find(string $path, mixed $filter = null, int|null $flags = null): Iterator
Находит файлы/каталоги (без рекурсии) в заданном пути к каталогу.
Параметры
-
string$path Путь к каталогу.
-
mixed$filter optional Если строка, будет использоваться как регулярное выражение для фильтрации, если вызываемая функция, будет как обратный вызов для
CallbackFilterIterator.-
int|null$flags optional Флаги для FilesystemIterator::__construct();
Возвращает
IteratorfindRecursive() public
findRecursive(string $path, mixed $filter = null, int|null $flags = null): Iterator
Находит файлы/каталоги рекурсивно в заданном пути к каталогу.
Параметры
-
string$path Путь к каталогу.
-
mixed$filter optional Если строка, будет использоваться как регулярное выражение для фильтрации, если вызываемая функция, будет как обратный вызов для
CallbackFilterIterator. Скрытые каталоги (начинающиеся с точки, например, .git) всегда пропускаются.-
int|null$flags optional Флаги для FilesystemIterator::__construct();
Возвращает
IteratorisStream() public
isStream(string $path): bool
Проверяет, является ли заданный путь путем к потоку.
Параметры
-
string$path Путь.
Возвращает
boolmkdir() public
mkdir(string $dir, int $mode = 0755): void
Создать каталог.
Параметры
-
string$dir Путь к каталогу.
-
int$mode optional Восьмеричный режим, передаваемый в mkdir(). По умолчанию 0755.
Возвращает
voidИсключения
Cake\Core\Exception\CakeExceptionПри ошибке создания каталога.
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.Filesystem.Filesystem.html