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

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

Если необходимо найти файлы на диске, используйте Finder.

Установка:

composer require nette/utils

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

use Nette\Utils\FileSystem;

Манипуляция

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

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

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

createDir(string $directory, 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, на $target. По умолчанию перезаписывает существующие файлы и каталоги. Если $overwrite установлен в false и $target уже существует, выбрасывается исключение Nette\InvalidStateException. Выбрасывает исключение 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

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

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

resolvePath(string $basePath, string $path): string

Выводит конечный путь из $path относительно базового каталога $basePath. Абсолютные пути (/foo, C:/foo) остаются без изменений (только нормализуются косые черты), относительные пути добавляются к базовому пути.

// В Windows косые черты в выводе будут обратными (\)
FileSystem::resolvePath('/base/dir', '/abs/path');      // '/abs/path'
FileSystem::resolvePath('/base/dir', 'rel');            // '/base/dir/rel'
FileSystem::resolvePath('base/dir', '../file.txt');     // 'base/file.txt'
FileSystem::resolvePath('base', '');                    // 'base'

Статический и нестатический подход

Чтобы легко заменить класс FileSystem на другой класс, например, для тестирования, используйте нестатический подход:

class AnyClassUsingFileSystem
{
	public function __construct(
		private FileSystem $fileSystem,
	) {
	}

	public function readConfig(): string
	{
		return $this->fileSystem->read(/* ... */);
	}

	...
}

Nette Documentation Preview