file_get_contents() w PHP: odczyt pliku do stringa

file_get_contents('notes.txt') odczytuje cały plik i zwraca go jako jeden string. Jeśli pliku nie da się odczytać, zwraca false. Do zapisu użyj file_put_contents('notes.txt', $text), które tworzy plik albo zastępuje jego zawartość.

<?php
file_put_contents('notes.txt', "Buy milk\nCall Ada\nWrite docs\n");

$text = file_get_contents('notes.txt');

echo $text;
echo strlen($text), " bytes\n";
echo substr_count($text, "\n"), " lines\n";

Wynik:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Blok najpierw zapisuje notes.txt, a potem go odczytuje, więc ma z czym pracować. Ścieżka taka jak 'notes.txt' jest względna do bieżącego katalogu roboczego; w aplikacji WWW buduj ścieżkę od własnego folderu skryptu przez __DIR__ . '/notes.txt'.

Zapis i dopisywanie przez file_put_contents()

file_put_contents() zwraca liczbę zapisanych bajtów albo false przy błędzie. Domyślnie nadpisuje plik. Flaga FILE_APPEND dopisuje zamiast tego na końcu, tak działają proste logi, a LOCK_EX nie pozwala dwóm żądaniom zapisywać w tej samej chwili:

<?php
$bytes = file_put_contents('log.txt', "started\n");
echo "Wrote $bytes bytes\n";

file_put_contents('log.txt', "step 1 done\n", FILE_APPEND | LOCK_EX);
file_put_contents('log.txt', "step 2 done\n", FILE_APPEND | LOCK_EX);
echo file_get_contents('log.txt'), "\n";

file_put_contents('log.txt', "replaced\n");   // no flag: the old content is gone
echo file_get_contents('log.txt'), "\n";

// An array is written with its elements joined, with nothing between them
file_put_contents('list.txt', ['a', 'b', 'c']);
echo file_get_contents('list.txt'), "\n";
echo file_put_contents('list.txt', implode("\n", ['a', 'b', 'c'])), " bytes\n";

Wynik:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Aby zapisać tablicę i odczytać ją z powrotem jako tablicę, zapisz ją jako JSON przez json_encode() i odczytaj przez json_decode().

Odczyt pliku linia po linii przez file()

file() wczytuje plik do tablicy z jedną linią na element. Każda linia zachowuje na końcu znak nowej linii, chyba że przekażesz FILE_IGNORE_NEW_LINES, a FILE_SKIP_EMPTY_LINES odrzuca puste linie (działa tylko razem z FILE_IGNORE_NEW_LINES):

<?php
file_put_contents('todo.txt', "Buy milk\nCall Ada\n\nWrite docs\n");

$lines = file('todo.txt');
var_dump($lines[0]);   // the newline is still there

$lines = file('todo.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
foreach ($lines as $i => $line) {
    echo $i + 1, ". $line\n";
}

echo count($lines), " tasks\n";

Wynik:

string(9) "Buy milk
"
1. Buy milk
2. Call Ada
3. Write docs
3 tasks

file() i file_get_contents() wczytują cały plik do pamięci. To w porządku dla plików konfiguracyjnych i logów o rozmiarze kilku megabajtów. Plik o rozmiarze setek megabajtów czytaj zamiast tego po jednej linii przez fopen() i fgets().

Sprawdzanie, czy plik istnieje, przed odczytem

Gdy pliku brakuje, file_get_contents() zwraca false, a PHP wypisuje ostrzeżenie:

Warning: file_get_contents(missing.txt): Failed to open stream: No such file or directory in /home/index.php on line 2

Najpierw sprawdź przez is_file() (plik, który istnieje i nie jest katalogiem) albo file_exists() (plik lub katalog) i zawsze porównuj wynik z === false, bo pusty plik zwraca "", które też jest traktowane jak fałsz:

<?php
file_put_contents('empty.txt', '');

foreach (['empty.txt', 'missing.txt', '.'] as $path) {
    echo str_pad($path, 12);
    echo file_exists($path) ? 'exists ' : 'missing ';
    echo is_file($path) ? 'file ' : '';
    echo is_dir($path) ? 'directory ' : '';
    echo "\n";
}

$path = 'missing.txt';
if (!is_file($path) || !is_readable($path)) {
    echo "Cannot read $path, using defaults\n";
} else {
    $text = file_get_contents($path);
}

$text = file_get_contents('empty.txt');
var_dump($text === false, $text == false);   // not a failure, just empty
echo filesize('empty.txt'), " bytes\n";

Wynik:

empty.txt   exists file 
missing.txt missing 
.           exists directory 
Cannot read missing.txt, using defaults
bool(false)
bool(true)
0 bytes

Nie ukrywaj ostrzeżenia przez @file_get_contents(). Sprawdzenie z góry albo obsługa false sprawiają, że błąd pozostaje widoczny, gdy pójdzie nie tak coś innego.

Odczyt części pliku

Czwarty i piąty argument to przesunięcie w bajtach, od którego zacząć, i liczba bajtów do odczytu. Ujemne przesunięcie liczy od końca pliku. Argumenty nazwane pozwalają pominąć dwa argumenty pośrodku:

<?php
file_put_contents('data.txt', "HEADER\nline 2\nline 3\nlast line\n");

echo file_get_contents('data.txt', false, null, 0, 6), "\n";   // first 6 bytes
echo file_get_contents('data.txt', offset: 7, length: 6), "\n";
echo file_get_contents('data.txt', offset: -10);                 // last 10 bytes

Wynik:

HEADER
line 2
last line

Przesunięcia liczą bajty, a nie znaki. W UTF-8 znak japoński zajmuje 3 bajty, a polska litera 2, więc przesunięcie w środku takiego znaku przecina go na pół. Aby pracować na znakach, odczytaj cały string i użyj mb_substr().

Plik tekstowy na stronie WWW

Zawartość pliku to tekst, a tekst wypisywany do HTML trzeba escapować, inaczej < w pliku staje się znacznikiem. htmlspecialchars() go escapuje, a nl2br() zamienia znaki nowej linii w znaczniki <br>. Uruchom i spójrz na zakładkę Page:

<?php
file_put_contents('changelog.txt', <<<TXT
v1.2: Fixed <title> encoding
v1.1: Added "export" & "import"
v1.0: First release
TXT);

$text = file_get_contents('changelog.txt');
?>
<h3>Changelog</h3>
<p style="font-family: monospace"><?= nl2br(htmlspecialchars($text)) ?></p>
<p><?= count(file('changelog.txt')) ?> entries, <?= filesize('changelog.txt') ?> bytes</p>

Usuń htmlspecialchars() i uruchom ponownie: strona kończy się teraz na „v1.2: Fixed”, bo przeglądarka czyta <title> jako prawdziwy znacznik i połyka wszystko po nim jako tytuł strony. Strona htmlspecialchars() wyjaśnia, dlaczego ma to znaczenie dla wszystkiego, co może napisać użytkownik.

Odczyt URL przez file_get_contents()

Z włączonym allow_url_fopen (domyślnie w php.ini) file_get_contents() czyta też adresy URL i zwraca treść odpowiedzi. Kontekst strumienia dodaje metodę, nagłówki, treść i limit czasu:

<?php
$html = file_get_contents('https://example.com/');

$context = stream_context_create([
    'http' => [
        'method'  => 'POST',
        'header'  => "Content-Type: application/json\r\n",
        'content' => json_encode(['name' => 'Ada']),
        'timeout' => 5,
        'ignore_errors' => true,   // return the body of 4xx/5xx responses too
    ],
]);

$response = file_get_contents('https://api.example.com/users', false, $context);
if ($response === false) {
    // DNS failure, timeout, or a refused connection
}

Do ponawiania, przekierowań z limitami i czytelnych kodów błędów lepszym narzędziem jest cURL albo biblioteka klienta HTTP, taka jak Guzzle.

file_get_contents vs file() vs fopen()

Funkcje działające jednym wywołaniem same otwierają, czytają lub zapisują i zamykają plik, więc to właściwy wybór domyślny. Po fopen() sięgnij, gdy plik jest za duży, by trzymać go w pamięci, albo musisz trzymać go otwartym między operacjami.