Funzioni del filesystem

Nette\Utils\FileSystem è una classe che contiene funzioni utili per lavorare con il filesystem. Un vantaggio rispetto alle funzioni native di PHP è che lanciano eccezioni in caso di errori.

Per cercare i file sul disco, utilizzare il Finder.

Installazione:

composer require nette/utils

Gli esempi seguenti presuppongono che sia stato definito il seguente alias di classe:

use Nette\Utils\FileSystem;

Manipolazione

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

Copia un file o un'intera directory. Sovrascrive i file e le directory esistenti per impostazione predefinita. Se $overwrite è impostato su false e un $target esiste già, lancia un'eccezione Nette\InvalidStateException. Lancia un'eccezione Nette\IOException se si verifica un errore.

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

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

Crea una directory se non esiste, comprese le directory parentali. Lancia un'eccezione Nette\IOException se si verifica un errore.

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

delete (string $path): void

Elimina un file o un'intera directory, se esistente. Se la directory non è vuota, ne cancella prima il contenuto. Lancia un'eccezione Nette\IOException se si verifica un errore.

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

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

Imposta i permessi dei file a $fileMode o i permessi delle directory a $dirMode. Esegue una ricerca ricorsiva e imposta i permessi anche sull'intero contenuto della directory.

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

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

Apre il file e restituisce la risorsa. Il parametro $mode funziona come la funzione nativa fopen(). Se si verifica un errore, viene sollevata l'eccezione Nette\IOException.

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

read (string $file): string

Legge il contenuto di un file $file. Lancia un'eccezione Nette\IOException se si verifica un errore.

$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 legge l'intero file in memoria, ma lo legge continuamente, in modo da poter leggere file più grandi della memoria disponibile. Il parametro $stripNewLines specifica se eliminare i caratteri di interruzione di riga \r e \n. In caso di errore, solleva un'eccezione 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

Rinomina o sposta un file o una directory specificata da $origin a $target. Sovrascrive i file e le directory esistenti per impostazione predefinita. Se $overwrite è impostato su false e $target esiste già, lancia un'eccezione Nette\InvalidStateException. Lancia un'eccezione Nette\IOException se si verifica un errore.

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

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

Scrive il file $content in un file $file. Lancia un'eccezione Nette\IOException se si verifica un errore.

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

Percorsi

isAbsolute (string $path): bool

Determina se il sito $path è assoluto.

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

joinPaths (string …$segments): string

Unisce 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.

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

unixSlashes (string $path): string

Converte gli slash in / utilizzati nei sistemi Unix.

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

platformSlashes (string $path): string

Converte gli slash in caratteri specifici della piattaforma corrente, ad esempio \ su Windows e / altrove.

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

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

Deriva il percorso finale da $path relativo alla directory di base $basePath. I percorsi assoluti (/foo, C:/foo) vengono lasciati invariati (normalizza solo gli slash), i percorsi relativi vengono aggiunti al percorso di base.

// In Windows, gli slash nell'output sarebbero invertiti (\)
FileSystem::resolvePath('/base/dir', '/abs/path');      // '/abs/percorso'
FileSystem::resolvePath('/base/dir', 'rel');            // '/base/dir/rel'
FileSystem::resolvePath('base/dir', '../file.txt');     // 'base/file.txt'
FileSystem::resolvePath('base', '');                    // 'base'

Approccio statico e non statico

Per sostituire facilmente la classe FileSystem con un'altra classe, ad esempio a scopo di test, utilizzarla in modo non statico:

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

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

	...
}