(PHP 4, PHP 5, PHP 7, PHP 8)
fopen — Открывает файл или URL-адрес
$filename,$mode,$use_include_path = false,$context = null
Функция fopen() связывает именованный ресурс
filename с потоком.
filename
Если значение аргумента для параметра filename передали в форме «scheme://...»,
значение считается URL-адресом и PHP проведёт поиск обработчика протокола
(который также знают как «обёртку») для этой схемы. Если для этого протокола
не зарегистрировали ни одной обёртки, PHP выдаст замечание,
чтобы помочь отследить потенциальную проблему
в скрипте, а затем продолжит выполнение так, как если бы параметр filename
указывал на обыкновенный файл.
Если PHP решил, что имя файла filename указывает
на локальный файл, выполняется попытка открыть поток для этого файла.
PHP требуется доступ к файлу, поэтому необходимо убедиться,
что права доступа к файлу разрешают доступ.
PHP применит дополнительные ограничения,
если включили директиву open_basedir.
Если PHP решил, что параметр filename указывает
на зарегистрированный протокол и этот протокол зарегистрирован
как сетевой URL-адрес, PHP проверит, включили ли директиву
allow_url_fopen.
PHP выдаст предупреждение и вызов функции fopen() завершится ошибкой,
если директиву выключили.
Замечание:
Список поддерживаемых протоколов перечисляет раздел «Протоколы и обёртки». Отдельные протоколы, или
обёртки, поддерживают опцииконтекстаи (или) файла php.ini. Обратитесь к странице с описанием протокола, чтобы получить список опций, которые можно установить (например, значение директивыuser_agentв файле php.ini использует обёрткаhttp).
На платформе Windows требуется экранировать обратные слеши в пути к файлу или указывать прямые слеши.
<?php
$handle = fopen("c:\\folder\\resource.txt", "r");
?>mode
Параметр mode указывает тип доступа
к потоку. Доступны следующие режимы:
mode |
Описание |
|---|---|
'r' |
Открывает файл только для чтения; помещает указатель в начало файла. |
'r+' |
Открывает файл для чтения и записи; помещает указатель в начало файла. |
'w' |
Открывает файл только для записи; помещает указатель в начало файла и обрезает файл до нулевой длины. Функция пытается создать файл, если файл не существует. |
'w+' |
Открывает файл для чтения и записи; в остальном ведёт себя так же,
как флаг 'w'.
|
'a' |
Открывает файл только для записи; помещает указатель в конец файла. Функция пытается создать файл, если файл не существует. В этом режиме функция fseek() не влияет на положение указателя, записи каждый раз добавляются в конец. |
'a+' |
Открывает файл для чтения и записи; помещает указатель в конец файла. Функция пытается создать файл, если файл не существует. В этом режиме функция fseek() влияет только на позицию считывания, записи каждый раз добавляются в конец. |
'x' |
Создаёт и открывает файл только для записи; помещает указатель
в начало файла. Вызов функции fopen() закончится неудачей,
вернёт false и выдаст ошибку уровня E_WARNING,
если файл уже существует.
Функция пытается создать файл, если файл не существует. Это эквивалентно
указанию флагов O_EXCL|O_CREAT для внутреннего
системного вызова open(2).
|
'x+' |
Создаёт и открывает файл для чтения и записи; в остальном ведёт себя так же,
как флаг 'x'.
|
'c' |
Открывает файл только для записи. Функция создаст файл, если файл не существует.
Файл не обрезается (в отличие от режима 'w'),
а вызов этой функции не вызывает ошибку (как и в случае с режимом 'x'),
если файл существует. Функция поместит указатель в начало файла.
Это может быть полезно, если требуется получить рекомендательную блокировку
(см. описание функции flock()) перед попыткой изменения файла, поскольку
режим 'w' может обрезать файл ещё до получения блокировки
(если требуется обрезать файл, можно вызывать функцию
ftruncate() после запроса на блокировку).
|
'c+' |
Открывает файл для чтения и записи; в остальном ведёт себя так же, как флаг 'c'.
|
'e' |
Устанавливает флаг close-on-exec (закрытия при исполнении) для открытого дескриптора файла. Флаг доступен только в PHP, который скомпилировали на системах с поддержкой стандарта POSIX.1-2008. |
Замечание:
В разных семействах операционных систем действуют разные соглашения о завершении строк. Когда при записи текстового файла требуется вставить разрыв строки, необходимо использовать правильный для операционной системы символ (или символы). Системы на базе Unix в качестве символа конца строки используют символ
\n, системы семейства Windows в качестве символов окончания строки используют последовательность символов\r\n, а системы семейства Macintosh (Mac OS Classic) — символ\r.Если при записи файлов используются неправильные символы конца строки, может обнаружиться, что другие приложения, которые открывают эти файлы, «выглядят странно».
ОС Windows предлагает флаг перевода в текстовый режим (
't'), который во время работы с файлом автоматически переведёт символ\nв символы\r\n. И наоборот — можно также использовать флаг'b', чтобы принудительно включить двоичный режим, который не будет переводить данные. Чтобы использовать эти флаги, значение'b'или't'указывают последним символом параметраmode.Режим перевода по умолчанию — флаг
'b'. При работе с простыми текстовыми файлами можно указать режим't', а для обозначения концов строк в скрипте использовать режим\n, но помнить, что файлы будут использоваться в приложениях наподобие старых версий «Блокнота». В остальных случаях лучше указывать флаг'b'.Иногда при работе с двоичными файлами, для которых указали флаг 't', возникают странные проблемы с данными, включая повреждённые файлы изображений и проблемы с символами
\r\n.
Замечание:
В целях переносимости также настоятельно рекомендуется переписать код, который использует или полагается на режим
't', чтобы вместо этого режима использовались правильные окончания строк и режим'b'.
Замечание: Функция игнорирует параметр
modeпри работе с обёртками потоков php://output, php://input, php://stdin, php://stdout, php://stderr и php://fd.
use_include_path
Для необязательного третьего параметра use_include_path
разрешается устанавливать значение true, если также требуется
искать файл в списке путей директивы include_path.
contextРесурс (resource) контекста потока.
Функция возвращает указатель на файл в случае успешного выполнения или false, если возникла ошибка
При сбое функция генерирует ошибку уровня E_WARNING.
| Версия | Описание |
|---|---|
| 7.0.16, 7.1.2 |
Добавили флаг 'e'.
|
Пример #1 Примеры использования функции fopen()
<?php
$handle = fopen("/home/rasmus/file.txt", "r");
$handle = fopen("/home/rasmus/file.gif", "wb");
$handle = fopen("http://www.example.com/", "r");
$handle = fopen("ftp://user:password@example.com/somefile.txt", "w");
?>При работе с сервером Microsoft IIS
по SSL-протоколу разработчик сталкивается с тем, что IIS-сервер
нарушает протокол путём закрытия соединения без отправки индикатора close_notify.
PHP выдаст ошибку в виде сообщения «SSL: Fatal Protocol Error» при достижении конца данных.
Чтобы избежать такого поведения, значение директивы error_reporting снижают до уровня,
который не включает предупреждений уровня E_WARNING. PHP умеет обнаруживать ошибочное программное обеспечение IIS-сервера
при открытии потока через обёртку https://, и подавляет предупреждение.
За обнаружение и подавление предупреждения отвечает разработчик, который вызывает функцию
fsockopen(), чтобы создать сокет ssl://.
Замечание:
Не забудьте проверить, что у серверного процесса есть доступ к файлам и каталогам, если при работе PHP в качестве версии серверного модуля возникли ошибки чтения или записи файлов.
Замечание:
Функция умеет принимать каталог как аргумент для параметра
filename. До вызова функции fopen() иногда требуется вызов функции is_dir(), когда неизвестно, параметрfilename— файл или каталог.