Функции на файловата система

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

Статичен срещу нестатичен подход

За да замените лесно класа FileSystem с друг клас, например за целите на тестването, използвайте го нестатично:

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

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

	...
}