Funkcje systemu plików

Nette\Utils\FileSystem to klasa, która zawiera przydatne funkcje do pracy z systemem plików. Jedną z zalet w porównaniu z natywnymi funkcjami PHP jest to, że rzucają wyjątki w przypadku błędów.

Jeśli chcesz wyszukać pliki na dysku, użyj Finder.

Instalacja:

composer require nette/utils

Poniższe przykłady zakładają, że zdefiniowany jest następujący alias klasy:

use Nette\Utils\FileSystem;

Manipulacja

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

Kopiuje plik lub cały katalog. Domyślnie nadpisuje istniejące pliki i katalogi. Jeśli $overwrite jest ustawione na false, a $target już istnieje, rzuca wyjątek Nette\InvalidStateException. Rzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

createDir(string $directory, int $mode=0777): void

Tworzy katalog, jeśli nie istnieje, łącznie z katalogami nadrzędnymi. Rzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

delete(string $path): void

Usuwa plik lub cały katalog, jeśli istnieje. Jeśli katalog nie jest pusty, najpierw usuwa jego zawartość. Rzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

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

Ustawia uprawnienia do plików na $fileMode lub uprawnienia do katalogów na $dirMode. Rekursywnie przemierza i ustawia uprawnienia również na całej zawartości katalogu.

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

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

Otwiera plik i zwraca zasób. Parametr $mode działa tak samo jak natywna funkcja fopen(). Jeśli wystąpi błąd, podnosi wyjątek Nette\IOException.

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

read(string $file): string

Odczytuje zawartość pliku $file. Rzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

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

Odczytuje zawartość pliku linia po linii. W odróżnieniu od natywnej funkcji file(), nie czyta ona całego pliku do pamięci, lecz czyta go w sposób ciągły, dzięki czemu można odczytać pliki większe niż dostępna pamięć. Parametr $stripNewLines określa, czy usuwać znaki przerwania linii \r i \n. W przypadku błędu podnosi wyjątek 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

Zmienia nazwę lub przenosi plik lub katalog określony przez $origin na $target. Domyślnie nadpisuje istniejące pliki i katalogi. Jeśli $overwrite jest ustawione na false a $target już istnieje, rzuca wyjątek Nette\InvalidStateException. Rzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

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

Zapisuje adres $content na adres $file. Wyrzuca wyjątek Nette\IOException w przypadku wystąpienia błędu.

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

Ścieżki

isAbsolute(string $path): bool

Określa, czy strona $path jest bezwzględna.

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

joinPaths(string …$segments): string

Łączy wszystkie segmenty ścieżki i normalizuje wynik.

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

Normalizuje .. i . oraz separatory katalogów w ścieżce.

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

unixSlashes(string $path): string

Konwertuje ukośniki na / używane w systemach uniksowych.

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

platformSlashes(string $path): string

Konwertuje ukośniki na znaki specyficzne dla bieżącej platformy, tj. \ w systemie Windows i / gdzie indziej.

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

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

Wyprowadza ostateczną ścieżkę z $path względem katalogu bazowego $basePath. Ścieżki bezwzględne (/foo, C:/foo) pozostają niezmienione (tylko normalizuje ukośniki), ścieżki względne są dołączane do ścieżki bazowej.

// W systemie Windows ukośniki na wyjściu byłyby odwrócone (\)
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'

Podejście statyczne i niestatyczne

Aby łatwo zastąpić klasę FileSystem inną klasą, na przykład do celów testowych, należy użyć jej w sposób niestatyczny:

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

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

	...
}