Sistema di file

Nette\Utils\FileSystem è una classe con funzioni utili per lavorare con il file system. Uno dei vantaggi rispetto alle funzioni PHP native è che lanciano eccezioni in caso di errore.

Se hai bisogno di cercare file sul disco, usa Finder.

Installazione:

composer require nette/utils

Gli esempi seguenti presuppongono la creazione di un alias:

use Nette\Utils\FileSystem;

Manipolazione

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

Copia un file o un'intera directory. Per impostazione predefinita, sovrascrive i file e le directory esistenti. Con il parametro $overwrite impostato su false, lancia un'eccezione Nette\InvalidStateException se il file o la directory di destinazione $target esiste. In caso di errore, lancia un'eccezione Nette\IOException.

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

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

Crea una directory se non esiste, incluse le directory padre. In caso di errore, lancia un'eccezione Nette\IOException.

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

delete (string $path): void

Elimina un file o un'intera directory se esiste. Se la directory non è vuota, elimina prima il suo contenuto. In caso di errore, lancia un'eccezione Nette\IOException.

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

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

Imposta i permessi del file su $fileMode o della directory su $dirMode. Attraversa ricorsivamente e imposta i permessi anche per l'intero contenuto della directory.

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

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

Apre un file e restituisce una risorsa. Il parametro $mode funziona allo stesso modo della funzione nativa fopen(). In caso di errore, lancia un'eccezione Nette\IOException.

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

read (string $file): string

Restituisce il contenuto del file $file. In caso di errore, lancia un'eccezione Nette\IOException.

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

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

Legge il contenuto del file riga per riga. A differenza della funzione nativa file(), non carica l'intero file in memoria, ma lo legge progressivamente, rendendo possibile leggere anche file più grandi della memoria disponibile. $stripNewLines indica se rimuovere i caratteri di fine riga \r e \n. In caso di errore, lancia un'eccezione Nette\IOException.

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

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

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

Rinomina o sposta il file o la directory $origin. Per impostazione predefinita, sovrascrive i file e le directory esistenti. Con il parametro $overwrite impostato su false, lancia un'eccezione Nette\InvalidStateException se il file o la directory di destinazione $target esiste. In caso di errore, lancia un'eccezione Nette\IOException.

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

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

Scrive la stringa $content nel file $file. In caso di errore, lancia un'eccezione Nette\IOException.

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

Percorsi

isAbsolute (string $path): bool

Determina se il percorso $path è assoluto.

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

joinPaths (string …$segments): string

Congiunge tutti i segmenti del percorso e normalizza il risultato.

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

Normalizza .. e . e i separatori di directory nel percorso a quelli di sistema (/).

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

unixSlashes (string $path): string

Converte le barre rovesciate in / utilizzate nei sistemi Unix.

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

platformSlashes (string $path): string

Converte le barre nei caratteri specifici della piattaforma corrente, cioè \ su Windows e / altrove.

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

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

Deriva il percorso finale dal percorso $path rispetto alla directory di base $basePath. Lascia invariati i percorsi assoluti (/foo, C:/foo) (normalizza solo le barre), i percorsi relativi vengono aggiunti al percorso di base.

// Su Windows le barre nell'output sarebbero invertite (\)
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'

Approccio statico vs non statico

Ad esempio, per poter sostituire facilmente la classe con un'altra (un mock) a scopo di test, utilizzala in modo non statico:

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

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

	...
}