Spec-Zone.ru › CakePHP 4.3

Класс Filesystem

Это предоставляет удобные обертки вокруг общих запросов к файловой системе.

Это внутренний вспомогательный класс, который не следует использовать в прикладном коде, так как он не гарантирует совместимости.

Пространство имен: Cake\Filesystem

Константы

  • string
    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, mixed $filter): Iterator

Оборачивает итератор дополнительным фильтрующим итератором.

Параметры

Iterator $iterator

Итератор

mixed $filter

Строка регулярного выражения или обратный вызов.

Возвращает

Iterator

find() public

find(string $path, mixed $filter = null, int|null $flags = null): Iterator

Находит файлы/каталоги (без рекурсии) в заданном пути к каталогу.

Параметры

string $path

Путь к каталогу.

mixed $filter optional

Если строка, будет использоваться как регулярное выражение для фильтрации, если вызываемая функция, будет как обратный вызов для CallbackFilterIterator.

int|null $flags optional

Флаги для FilesystemIterator::__construct();

Возвращает

Iterator

findRecursive() 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();

Возвращает

Iterator

isStream() public

isStream(string $path): bool

Проверяет, является ли заданный путь путем к потоку.

Параметры

string $path

Путь.

Возвращает

bool

mkdir() 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API