Работа с файлами в PHP: чтение, запись, удаление
Небольшой файл в PHP можно прочитать или записать одним вызовом. Для построчной обработки, ограничения объёма чтения и управления блокировками нужен файловый поток. Разберём, как выбирать функции и проверять результат каждой операции.
Файл в PHP: пути, права и проверка через file_exists()
Файловые функции PHP принимают путь строкой. Относительный путь отсчитывается от текущего рабочего каталога, который возвращает getcwd(). Он может различаться при запуске из CLI, веб-сервера и планировщика. Если путь привязан к расположению скрипта, соберите его через __DIR__.
<?php
declare(strict_types=1);
$path = __DIR__ . '/notes.txt';
// file_exists() подходит для проверки файла или каталога.
if (file_exists($path) && is_file($path)) {
echo 'Обычный файл найден', PHP_EOL;
}is_file() проверяет, что путь указывает на обычный файл, is_dir() — на каталог. Для выбора операции обычно хватает одной из этих проверок. is_readable() и is_writable() полезны в диагностике прав. Между проверкой и вызовом файл может исчезнуть, а права могут измениться, поэтому всегда проверяйте результат самой операции.
Для операций создания, переименования и удаления важны права на родительский каталог. Например, в Unix удаление зависит от возможности изменить запись в каталоге и пройти по пути до него. При работе из веб-приложения проверяйте права пользователя, от которого запущен PHP, и ограничения open_basedir.
Для путей из запроса используйте фиксированный базовый каталог и разрешённые имена. Надёжный вариант — принять идентификатор, найти по нему имя в базе и собрать путь на сервере. Простая конкатенация каталога с пользовательской строкой допускает выход за его пределы через ../. Если пользователи могут создавать символические ссылки в хранилище, учитывайте и их при проверке границ каталога.
Как прочитать файл: file_get_contents() и file()
file_get_contents() читает содержимое в строку. Это удобно для небольших JSON-файлов, конфигураций и шаблонов. При ошибке функция возвращает false и обычно выдаёт предупреждение E_WARNING. Пустая строка и строка '0' — корректные результаты, поэтому сравнивайте возвращённое значение строго.
<?php
declare(strict_types=1);
// config.json лежит рядом со скриптом и содержит JSON.
$contents = file_get_contents(__DIR__ . '/config.json');
if ($contents === false) {
throw new RuntimeException('Не удалось прочитать config.json');
}
$config = json_decode($contents, true, 512, JSON_THROW_ON_ERROR);JSON_THROW_ON_ERROR сообщает об ошибке формата через JsonException. Так сбой чтения и повреждённый JSON обрабатываются по отдельности. Для выборки начала файла укажите именованный аргумент length, например file_get_contents($path, length: 4096). Это ограничит чтение 4096 байтами.
Функция file() в PHP сразу возвращает массив строк. Используйте FILE_IGNORE_NEW_LINES, чтобы убрать окончания строк. Если нужно пропустить пустые строки, добавьте FILE_SKIP_EMPTY_LINES. Строки, состоящие из пробелов, можно отфильтровать отдельно.
<?php
declare(strict_types=1);
// Сохраняем пустые строки, убираем только окончания строк.
$lines = file(__DIR__ . '/notes.txt', FILE_IGNORE_NEW_LINES);
if ($lines === false) {
throw new RuntimeException('Не удалось прочитать notes.txt');
}
echo 'Строк: ', count($lines), PHP_EOL;Обе функции загружают данные в память. Массив из file() дополнительно расходует память на каждый элемент. Для журналов, выгрузок и файлов с неизвестным размером используйте потоковое чтение.
fopen() в PHP: построчное чтение и режимы открытия
fopen() возвращает поток или false. Читайте текст через fgets(), а двоичные данные — блоками через fread(). Закрывайте открытый поток в finally, чтобы освободить ресурс даже при исключении внутри обработки.
<?php
declare(strict_types=1);
$stream = fopen(__DIR__ . '/notes.txt', 'rb');
if ($stream === false) {
throw new RuntimeException('Не удалось открыть notes.txt');
}
try {
// Обрабатываем по одной строке, включая последнюю без перевода строки.
while (($line = fgets($stream)) !== false) {
echo $line;
}
if (!feof($stream)) {
throw new RuntimeException('Чтение прервалось до конца файла');
}
} finally {
fclose($stream);
}Чтение по строкам удерживает в памяти текущую строку. Если входной файл может содержать строку произвольной длины, ограничьте размер порции через второй аргумент fgets() или используйте блоки фиксированного размера. Вариант с while (!feof($stream)) часто приводит к лишней обработке после последней строки. Надёжнее строить цикл на результате чтения.
| Режим | Что делает |
|---|---|
rb | Открывает существующий файл для чтения. |
wb | Создаёт файл или сразу обнуляет существующий. |
ab | Создаёт файл при необходимости и пишет в конец. |
xb | Создаёт новый файл для записи. Если путь уже занят, открытие завершается ошибкой. |
c+b | Открывает файл для чтения и записи, создаёт его при необходимости и сохраняет прежнее содержимое при открытии. |
Модификатор b включает двоичный режим, чтобы поведение с переводами строк было одинаковым на Windows и Unix. Для записи в открытый поток используйте fwrite(). Она возвращает число записанных байтов или false. Если записана только часть данных, продолжайте с оставшегося фрагмента. Возврат 0 при непустом остатке требует выхода из цикла с ошибкой.
Как записать в файл в PHP через file_put_contents()
file_put_contents() создаёт файл или заменяет его содержимое. Родительский каталог должен существовать. Для записи в конец используйте FILE_APPEND, для эксклюзивной блокировки на время записи — LOCK_EX. Возвращаемое число — объём записи в байтах, поэтому успешная запись пустой строки даёт 0.
<?php
declare(strict_types=1);
$path = __DIR__ . '/app.log';
$entry = gmdate('c') . ' Задача выполнена' . PHP_EOL;
// Добавляем запись в журнал под эксклюзивной блокировкой.
$written = file_put_contents($path, $entry, FILE_APPEND | LOCK_EX);
if ($written === false || $written !== strlen($entry)) {
throw new RuntimeException('Запись в журнал не завершилась');
}Для полной перезаписи вызовите file_put_contents($path, $data, LOCK_EX). При параллельной работе блокировка помогает, когда все участники используют совместимый протокол. Читатель может открыть поток, взять разделяемую блокировку flock($stream, LOCK_SH) и прочитать его. Обычный file_get_contents() такую блокировку сам не берёт.
Как заменить файл целиком при параллельном чтении
Запишите данные во временный файл в том же каталоге, проверьте число записанных байтов и вызовите rename(). На локальной файловой системе с атомарной заменой читатели увидят старую или новую версию. Этот приём защищает от чтения частично записанного файла. Если два процесса вычисляют новую версию на основе старой, им также нужна блокировка на весь цикл чтения, изменения и замены.
<?php
declare(strict_types=1);
$target = __DIR__ . '/state.json';
$data = json_encode(['ready' => true], JSON_THROW_ON_ERROR);
$dir = dirname($target);
$tmp = tempnam($dir, '.state-');
if ($tmp === false) {
throw new RuntimeException('Не удалось создать временный файл');
}
try {
// tempnam() может выбрать системный временный каталог.
if (dirname($tmp) !== $dir) {
throw new RuntimeException('Временный файл создан вне каталога назначения');
}
if (file_put_contents($tmp, $data) !== strlen($data)) {
throw new RuntimeException('Временный файл записан не полностью');
}
if (!rename($tmp, $target)) {
throw new RuntimeException('Не удалось заменить state.json');
}
$tmp = null;
} finally {
if ($tmp !== null) {
unlink($tmp);
}
}Файл после замены получает права временного файла. Если результат должны читать другие пользователи системы, настройте нужные права до rename(). На Windows открытый файл назначения может помешать замене. Проверяйте результат переименования и сохраняйте рабочую версию при сбое.
Копирование через copy(), размер через filesize() и удаление файла
copy($source, $destination) копирует файл и возвращает true при успехе. При существующем файле назначения функция может его перезаписать. Если назначение должно создаваться только один раз, откройте его в режиме xb и скопируйте данные через stream_copy_to_stream(). Проверка file_exists() перед копированием оставляет промежуток, в котором другой процесс может занять путь.
filesize() возвращает размер в байтах или false. Для пустого файла размер равен нулю. PHP кэширует результаты ряда проверок метаданных. Если файл изменился во время работы скрипта и нужен свежий размер, вызовите clearstatcache() перед повторной проверкой. Размер по пути отражает состояние файла в момент проверки и может измениться до чтения.
<?php
declare(strict_types=1);
$source = __DIR__ . '/notes.txt';
$backup = __DIR__ . '/notes.backup.txt';
// При повторном запуске предыдущая резервная копия перезапишется.
if (!copy($source, $backup)) {
throw new RuntimeException('Не удалось скопировать notes.txt');
}
clearstatcache();
$size = filesize($backup);
if ($size === false) {
throw new RuntimeException('Не удалось определить размер копии');
}
echo $size, ' байт', PHP_EOL;Чтобы удалить файл в PHP, вызовите unlink(). При успехе функция возвращает true, при ошибке — false и предупреждение. Вызов для символической ссылки на обычный файл удаляет саму ссылку. Для удаления пустого каталога используйте rmdir().
<?php
declare(strict_types=1);
// Удаляем резервную копию, созданную предыдущим примером.
$backup = __DIR__ . '/notes.backup.txt';
if (!unlink($backup)) {
throw new RuntimeException('Не удалось удалить резервную копию');
}Каталоги в PHP: dir(), scandir() и FilesystemIterator
dir() возвращает объект Directory с методами read(), rewind() и close(). scandir() удобна, если нужен массив имён для сортировки или фильтрации. Для обхода каталога с доступом к типу и пути каждой записи подходит FilesystemIterator.
<?php
declare(strict_types=1);
// Обходим файлы рядом со скриптом. Точки и ссылки пропускаем.
$entries = new FilesystemIterator(__DIR__, FilesystemIterator::SKIP_DOTS);
foreach ($entries as $entry) {
if ($entry->isFile() && !$entry->isLink()) {
echo $entry->getFilename(), PHP_EOL;
}
}Итератор обходит один уровень. При рекурсивном обходе задайте правила для символических ссылок и границ каталога, особенно если обход используется для удаления. Для scandir() проверяйте возврат false и исключайте записи . и ...
Типичные ошибки и отличия PHP 8.3–8.5
- Пропущен строгий тест на ошибку. Для чтения, размера и объёма записи проверяйте
=== false. Пустой результат или ноль могут быть успешными. - Режим
wbвыбран для обновления. Файл обнуляется уже приfopen(). Если нужно сначала взять блокировку, откройте его вc+bи выполняйте изменение после успешногоflock(). - Путь правильный, а операция падает. Проверьте права на файл и каталог, свободное место и доступность файловой системы. Предупреждение PHP часто указывает причину. В веб-приложении отправляйте диагностические сообщения в журнал и показывайте клиенту сообщение без внутренних путей.
- Смешаны ошибки аргументов и файловой системы. В PHP 8.x неверный тип аргумента может вызвать
TypeError, а недопустимое значение —ValueError. Например,file_get_contents($path, length: -1)вызываетValueError. Отсутствующий файл при корректном пути обычно даёт предупреждение иfalse.
Примеры рассчитаны на PHP 8.3–8.5. Начиная с PHP 8.3, file() выбрасывает ValueError, если битовая маска содержит неподдерживаемые флаги. Передавайте только флаги, предусмотренные для этой функции. С PHP 8.4 константы E_STRICT и E_DEPRECATED имеют разный статус: E_STRICT объявлена устаревшей. В настройках диагностики используйте E_ALL без выражения ~E_STRICT. В PHP 8.5 для показанных вызовов отдельные ветки совместимости не нужны. declare(strict_types=1) помогает обнаруживать ошибки типов при вызовах из файла, а результаты операций ввода-вывода всё равно требуют проверки.
Чек-лист перед работой с файлами
- Соберите путь от известного каталога. Если имя приходит извне, проверьте его по правилам приложения.
- Для небольшого файла выберите
file_get_contents()илиfile(). Для большого используйтеfopen()с чтением порциями. - Определите режим записи: добавить, перезаписать, создать только новый файл или заменить его через временный.
- Проверяйте возвращаемые значения. Когда ожидается запись всего буфера, сравнивайте число записанных байтов с
strlen(). - При параллельном доступе договоритесь о блокировках. Перед копированием проверьте, допустима ли перезапись назначения, а перед удалением убедитесь, что путь выбран внутри нужного каталога.
Частые вопросы
Как записать строку в конец файла в PHP?
Вызовите file_put_contents($path, $text . PHP_EOL, FILE_APPEND | LOCK_EX). FILE_APPEND добавляет данные в конец, LOCK_EX берёт эксклюзивную блокировку на время записи. Проверьте число записанных байтов.
В чём разница между file_exists() и is_file()?
file_exists() проверяет существование пути к файлу или каталогу. is_file() возвращает true для обычного файла, в том числе когда на него указывает символическая ссылка. Для проверки каталога используйте is_dir().
Почему filesize() показывает прежний размер файла?
PHP может использовать кэш метаданных. Если файл изменился в ходе работы скрипта, вызовите clearstatcache() и повторите filesize(). Сравнивайте результат с false строго, чтобы корректно обработать пустой файл.