Fájlrendszer funkciók

Nette\Utils\FileSystem egy osztály, amely hasznos funkciókat tartalmaz a fájlrendszerrel való munkához. Egyik előnye a natív PHP függvényekkel szemben, hogy hiba esetén kivételeket dobnak.

Ha fájlokat kell keresnie a lemezen, használja a Finder programot.

Telepítés:

composer require nette/utils

A következő példák feltételezik, hogy a következő osztály alias van definiálva:

use Nette\Utils\FileSystem;

Manipuláció

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

Egy fájl vagy egy teljes könyvtár másolása. Alapértelmezés szerint felülírja a meglévő fájlokat és könyvtárakat. Ha a $overwrite értéke false, és a $target már létezik, a Nette\InvalidStateException kivételt dob. Hiba esetén kivételt dob Nette\IOException.

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

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

Létrehoz egy könyvtárat, ha az nem létezik, beleértve a szülői könyvtárakat is. Hiba esetén kivételt dob Nette\IOException.

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

delete(string $path): void

Töröl egy fájlt vagy egy teljes könyvtárat, ha létezik. Ha a könyvtár nem üres, akkor először annak tartalmát törli. Hiba esetén kivételt dob Nette\IOException.

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

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

A fájljogosultságokat a $fileMode vagy a könyvtárjogosultságokat a $dirMode értékre állítja. Rekurzívan végigjárja és beállítja a könyvtár teljes tartalmának engedélyeit is.

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

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

Megnyitja a fájlt és visszaadja az erőforrást. A $mode paraméter ugyanúgy működik, mint a natív fopen() függvény. Hiba esetén a Nette\IOException kivételt vet fel.

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

read(string $file): string

Beolvassa a $file tartalmát. Hiba esetén a Nette\IOException kivételt dobja.

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

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

Soronként olvassa be a fájl tartalmát. A natív file() függvénytől eltérően nem a teljes fájlt olvassa be a memóriába, hanem folyamatosan olvassa, így a rendelkezésre álló memóriánál nagyobb fájlok is beolvashatók. A $stripNewLines megadja, hogy a \r és a \n sortörő karakterek eltávolításra kerüljenek-e. Hiba esetén Nette\IOException kivételt vet fel.

$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

A $origin által megadott fájl vagy könyvtár átnevezése vagy áthelyezése a $target címre. Alapértelmezés szerint felülírja a meglévő fájlokat és könyvtárakat. Ha a $overwrite értéke false és a $target már létezik, akkor a Nette\InvalidStateException kivételt dob. Hiba esetén kivételt dob Nette\IOException.

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

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

A $content értéket a $file címre írja. Hiba esetén a Nette\IOException kivételt dob.

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

Útvonalak

isAbsolute(string $path): bool

Meghatározza, hogy a $path abszolút-e.

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

joinPaths(string …$segments): string

Összekapcsolja az útvonal összes szegmensét, és normalizálja az eredményt.

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

Normalizálja a .. és a . oldalakat, valamint a könyvtárak elválasztóit az elérési útvonalban.

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

unixSlashes(string $path): string

A Unix rendszereken használt / -ra konvertálja a slasheket.

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

platformSlashes(string $path): string

A slashes karaktereket az aktuális platformra jellemző karakterekre konvertálja, azaz Windowson \, máshol /.

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

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

A végső elérési útvonalat a $path könyvtárból származtatja a $basePath alapkönyvtárhoz képest. Az abszolút elérési utakat (/foo, C:/foo) változatlanul hagyja (csak a kötőjeleket normalizálja), a relatív elérési utakat hozzácsatolja az alap elérési útvonalhoz.

// Windowson a kimeneti oldalon a ferdehajlatok fordítva lesznek (\)
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'

Statikus vs. nem statikus megközelítés

A FileSystem osztályt könnyen lecserélhetjük egy másik osztályra, például tesztelési célokra, ha nem-statikusan használjuk:

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

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

	...
}