Файловая система

Nette\Utils\FileSystem это статический класс, содержащий полезные функции для работы с файловой системой. Одно из преимуществ перед собственными функциями PHP заключается в том, что они бросают исключения в случае ошибок.

Установка:

composer require nette/utils

В следующих примерах предполагается, что псевдоним уже создан:

use Nette\Utils\FileSystem;

Манипуляция

copy(string $origin, string $target, bool $overwrite=true)void

Копирует файл или целый каталог. По умолчанию перезаписывает существующие файлы и каталоги. С параметром $overwrite, установленным в false, вызывает исключение Nette\InvalidStateException, если целевой файл или каталог $target существует. При возникновении ошибки поднимается исключение Nette\IOException.

FileSystem::copy('/path/to/source', '/path/to/dest', overwrite: true);

createDir(string $dir, int $mode=0777)void

Создает каталог, если он не существует, включая родительские каталоги. Вызывает исключение Nette\IOException при возникновении ошибки.

FileSystem::createDir('/path/to/dir');

delete(string $path): void

Удаляет файл или весь каталог, если он существует. Если каталог не пуст, то сначала удаляется его содержимое. Если произошла ошибка, поднимите исключение Nette\IOException.

FileSystem::delete('/path/to/fileOrDir');

makeWritable(string $path, int $dirMode=0777, int $fileMode=0666)void

Устанавливает разрешения на файл по адресу $fileMode или каталог по адресу $dirMode. Рекурсивно просматривает и устанавливает разрешения на все содержимое каталога.

FileSystem::makeWritable('/path/to/fileOrDir');

open(string $path, string $mode): resource

Открывает файл и возвращает ресурс. Параметр $mode работает так же, как и собственные функции fopen(). При возникновении ошибки возникает исключение Nette\IOException.

$res = FileSystem::open('/path/to/file', 'r');

read(string $file): string

Возвращает содержимое файла $file. При возникновении ошибки выдает исключение Nette\IOException.

$content = FileSystem::read('/path/to/file');

readLines(string $file, bool $stripNewLines=true): \Generator

Читает содержимое файла построчно. В отличие от родной функции file(), она не загружает весь файл в память, а считывает его непрерывно, чтобы можно было читать файлы, размер которых превышает объем доступной памяти. $stripNewLines Указывает, следует ли сбривать символы конца строки \r и \n. Если произошла ошибка, поднимите исключение Nette\IOException.

$lines = FileSystem::readLines('/path/to/file');

foreach ($lines as $lineNum => $line) {
	echo "Line $lineNum: $line\n";
}

rename(string $origin, string $target, bool $overwrite=true)void

Переименование или перемещение файла или каталога $origin. По умолчанию перезаписывает существующие файлы и каталоги. С параметром $overwrite, установленным в false, вызывает исключение Nette\InvalidStateException, если целевой файл или каталог $target существует. При возникновении ошибки поднимается исключение Nette\IOException.

FileSystem::rename('/path/to/source', '/path/to/dest', overwrite: true);

write(string $file, string $content, int $mode=0666)void

Записывает строку $content в файл $file. При ошибке вызывает исключение Nette\IOException.

FileSystem::write('/path/to/file', $content);

Пути

isAbsolute(string $path)bool

Определяет, является ли путь $path абсолютным.

FileSystem::isAbsolute('../backup'); // false
FileSystem::isAbsolute('/backup');   // true
FileSystem::isAbsolute('C:/backup'); // true

joinPaths(string …$segments)string

Объединяет все сегменты пути и нормализует результат.

FileSystem::joinPaths('a', 'b', 'file.txt'); // 'a/b/file.txt'
FileSystem::joinPaths('/a/', '/b/');         // '/a/b/'
FileSystem::joinPaths('/a/', '/../b');       // '/b'

normalizePath(string $path)string

Нормализует .. и . и разделители каталогов в пути к системе.

FileSystem::normalizePath('/file/.');        // '/file/'
FileSystem::normalizePath('\file\..');       // '/file'
FileSystem::normalizePath('/file/../..');    // '/..'
FileSystem::normalizePath('file/../../bar'); // '/../bar'

unixSlashes(string $path)string

Преобразует косые черты в /, используемые в системах Unix.

$path = FileSystem::unixSlashes($path);

platformSlashes(string $path)string

Преобразует косые черты в символы, характерные для текущей платформы, т.е. \ ve Windows a / в других местах.

$path = FileSystem::platformSlashes($path);