PHP file_get_contents(): прочитать файл в строку

file_get_contents('notes.txt') читает весь файл и возвращает его одной строкой. Если файл нельзя прочитать, функция возвращает false. Для записи используйте file_put_contents('notes.txt', $text), которая создаёт файл или заменяет его содержимое.

<?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";

Вывод:

Buy milk
Call Ada
Write docs
29 bytes
3 lines

Блок сначала записывает notes.txt, а потом читает его обратно, чтобы было с каким файлом работать. Путь вроде 'notes.txt' отсчитывается от текущего рабочего каталога; в веб-приложении стройте путь от папки самого скрипта через __DIR__ . '/notes.txt'.

Запись и дописывание через file_put_contents()

file_put_contents() возвращает число записанных байтов или false при сбое. По умолчанию она перезаписывает файл. Флаг FILE_APPEND вместо этого дописывает в конец, так работают простые логи, а LOCK_EX не даёт двум запросам писать в один и тот же момент:

<?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";

Вывод:

Wrote 8 bytes
started
step 1 done
step 2 done

replaced

abc
5 bytes

Чтобы сохранить массив и получить его обратно массивом, запишите его в JSON через json_encode() и читайте через json_decode().

Чтение файла построчно через file()

file() читает файл в массив, где каждый элемент это строка. Каждая строка сохраняет перенос в конце, если не передать FILE_IGNORE_NEW_LINES, а FILE_SKIP_EMPTY_LINES отбрасывает пустые строки (работает только вместе с 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";

Вывод:

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

file() и file_get_contents() загружают весь файл в память. Для файлов настроек и логов в несколько мегабайт это нормально. Для файла в сотни мегабайт читайте по строке через fopen() и fgets().

Проверка наличия файла перед чтением

Когда файла нет, file_get_contents() возвращает false, а PHP печатает предупреждение:

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

Сначала проверьте через is_file() (файл существует и не является каталогом) или file_exists() (файл или каталог) и всегда сравнивайте результат с === false, потому что пустой файл возвращает "", а это тоже ложное значение:

<?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";

Вывод:

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

Не прячьте предупреждение через @file_get_contents(). Предварительная проверка или обработка false оставляет ошибку видимой, когда что-то ещё пойдёт не так.

Чтение части файла

Четвёртый и пятый аргументы это смещение в байтах, с которого начинать, и число байтов для чтения. Отрицательное смещение отсчитывается с конца файла. Именованные аргументы позволяют пропустить два аргумента между ними:

<?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

Вывод:

HEADER
line 2
last line

Смещения считаются в байтах, а не в символах. В UTF-8 японский символ занимает 3 байта, а буква кириллицы 2, поэтому смещение посреди символа разрезает его пополам. Чтобы работать с символами, прочитайте всю строку и используйте mb_substr().

Вывод текстового файла на веб-странице

Содержимое файла это текст, а текст, выводимый в HTML, нужно экранировать, иначе < в файле станет тегом. htmlspecialchars() экранирует его, а nl2br() превращает переносы строк в теги <br>. Запустите и посмотрите на вкладку 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>

Уберите htmlspecialchars() и запустите снова: теперь страница заканчивается на "v1.2: Fixed", потому что браузер читает <title> как настоящий тег и проглатывает всё после него как заголовок страницы. Почему это важно для всего, что может написать пользователь, рассказано на странице htmlspecialchars().

Чтение URL через file_get_contents()

При включённом allow_url_fopen (по умолчанию в php.ini) file_get_contents() читает и URL и возвращает тело ответа. Контекст потока добавляет метод, заголовки, тело и таймаут:

<?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
}

Для повторов, редиректов с ограничениями и понятных кодов ошибок лучше подходит cURL или библиотека HTTP-клиента вроде Guzzle.

file_get_contents, file() и fopen()

Функции с одним вызовом сами открывают файл, читают или пишут и закрывают его, поэтому они правильный выбор по умолчанию. Берите fopen(), когда файл слишком велик, чтобы держать его в памяти, или его нужно держать открытым между операциями.