fopen
fopen () связывает именованный ресурс, указанный в filename , с потоком.
Parameters
Если filename имеет форму «scheme: // . », предполагается, что это URL-адрес, и PHP будет искать обработчик протокола (также известный как оболочка) для этой схемы. Если никакие оболочки для этого протокола не зарегистрированы, PHP выдаст уведомление, чтобы помочь вам отслеживать потенциальные проблемы в вашем скрипте, а затем продолжит работу, как если бы filename указывает на обычный файл.
Если PHP решил, что filename указывает на локальный файл, он попытается открыть поток для этого файла. Файл должен быть доступен для PHP, поэтому вам необходимо убедиться, что разрешения на доступ к файлу разрешают этот доступ. Если вы включили open_basedir, могут применяться дополнительные ограничения.
Если PHP решил, что filename определяет зарегистрированный протокол и этот протокол зарегистрирован как сетевой URL-адрес, PHP проверит, включен ли параметр allow_url_fopen . Если он выключен, PHP выдаст предупреждение и вызов fopen завершится ошибкой.
Note:
Список поддерживаемых протоколов можно найти в разделе «Поддерживаемые протоколы и оболочки» . Некоторые протоколы (также называемые wrappers ) поддерживают параметры context и / или php.ini . Обратитесь к конкретной странице используемого протокола для получения списка опций, которые можно установить. (например, значение user_agent в php.ini , используемое оболочкой http ).
На платформе Windows будьте осторожны,чтобы избежать обратных слэшей,используемых в пути к файлу,или используйте прямые косые черты.
$handle = fopen("c:\\folder\\resource.txt", "r"); ?>
Параметр mode указывает тип требуемого доступа к потоку. Это может быть одно из следующего:
mode | Description |
---|---|
‘r’ | Открыт только для чтения;поместите указатель на файл в начало файла. |
‘r+’ | Открыть для чтения и записи;поместить указатель на файл в начало файла. |
‘w’ | Открыть только для записи;поместить указатель на файл в начало файла и усечь файл до нулевой длины.Если файл не существует,попробуйте его создать. |
‘w+’ | Открыт для чтения и письма; в противном случае он ведет себя так же, как ‘w’ . |
‘a’ | Открыт только для записи; поместите указатель файла в конец файла. Если файл не существует, попытайтесь создать его. В этом режиме fseek () не действует, записи всегда добавляются. |
‘a+’ | Открыт для чтения и письма; поместите указатель файла в конец файла. Если файл не существует, попытайтесь создать его. В этом режиме fseek () влияет только на позицию чтения, записи всегда добавляются. |
‘x’ | Создавать и открывать только для записи; поместите указатель файла в начало файла. Если файл уже существует, вызов fopen () завершится неудачно, вернет false и выдаст ошибку уровня E_WARNING . Если файл не существует, попробуйте его создать. Это эквивалентно O_EXCL|O_CREAT флагов O_EXCL | O_CREAT для базового системного вызова open(2) . |
‘x+’ | Создавать и открывать для чтения и письма; в противном случае он ведет себя так же, как ‘x’ . |
‘c’ | Открыть файл только для записи. Если файл не существует, он создается. Если он существует, он не усекается (в отличие от ‘w’ ), и вызов этой функции не завершается неудачно (как в случае с ‘x’ ). Указатель файла располагается в начале файла. Это может быть полезно, если желательно получить рекомендательную блокировку (см. Flock () ) перед попыткой изменения файла, поскольку использование ‘w’ могло бы обрезать файл до того, как блокировка была получена (если требуется усечение, ftruncate () может быть используется после запроса блокировки). |
‘c+’ | Откройте файл для чтения и записи; в противном случае он ведет себя так же, как ‘c’ . |
‘e’ | Установите флаг close-on-exec на дескрипторе открытого файла.Доступно только в PHP,скомпилированном на системах,соответствующих POSIX.1-2008. |
Note:
В разных семействах операционных систем используются разные обозначения окончания строк. Когда вы пишете текстовый файл и хотите вставить разрыв строки, вам необходимо использовать правильный (е) символ (символы) окончания строки для вашей операционной системы. Системы на основе 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 .
Note:
Для переносимости также настоятельно рекомендуется переписать код, который использует или полагается на режим ‘t’ чтобы вместо него использовались правильные окончания строк и режим ‘b’ .
Примечание . Этот mode игнорируется для обработчиков потоков php://output , php://input , php://stdin , php://stdout , php://stderr и php://fd .
Необязательный третий параметр use_include_path может иметь значение «1» или true , если вы также хотите искать файл в include_path .
Return Values
Возвращает ресурс указателя файла в случае успеха или false в случае неудачи
fopen
fopen() binds a named resource, specified by filename , to a stream.
Parameters
If filename is of the form «scheme://. «, it is assumed to be a URL and PHP will search for a protocol handler (also known as a wrapper) for that scheme. If no wrappers for that protocol are registered, PHP will emit a notice to help you track potential problems in your script and then continue as though filename specifies a regular file.
If PHP has decided that filename specifies a local file, then it will try to open a stream on that file. The file must be accessible to PHP, so you need to ensure that the file access permissions allow this access. If you have enabled open_basedir further restrictions may apply.
If PHP has decided that filename specifies a registered protocol, and that protocol is registered as a network URL, PHP will check to make sure that allow_url_fopen is enabled. If it is switched off, PHP will emit a warning and the fopen call will fail.
Note:
The list of supported protocols can be found in Supported Protocols and Wrappers. Some protocols (also referred to as wrappers ) support context and/or php.ini options. Refer to the specific page for the protocol in use for a list of options which can be set. (e.g. php.ini value user_agent used by the http wrapper).
On the Windows platform, be careful to escape any backslashes used in the path to the file, or use forward slashes.
$handle = fopen("c:\\folder\\resource.txt", "r"); ?>
The mode parameter specifies the type of access you require to the stream. It may be any of the following:
mode | Description |
---|---|
‘r’ | Open for reading only; place the file pointer at the beginning of the file. |
‘r+’ | Open for reading and writing; place the file pointer at the beginning of the file. |
‘w’ | Open for writing only; place the file pointer at the beginning of the file and truncate the file to zero length. If the file does not exist, attempt to create it. |
‘w+’ | Open for reading and writing; otherwise it has the same behavior as ‘w’ . |
‘a’ | Open for writing only; place the file pointer at the end of the file. If the file does not exist, attempt to create it. In this mode, fseek() has no effect, writes are always appended. |
‘a+’ | Open for reading and writing; place the file pointer at the end of the file. If the file does not exist, attempt to create it. In this mode, fseek() only affects the reading position, writes are always appended. |
‘x’ | Create and open for writing only; place the file pointer at the beginning of the file. If the file already exists, the fopen() call will fail by returning false and generating an error of level E_WARNING . If the file does not exist, attempt to create it. This is equivalent to specifying O_EXCL|O_CREAT flags for the underlying open(2) system call. |
‘x+’ | Create and open for reading and writing; otherwise it has the same behavior as ‘x’ . |
‘c’ | Open the file for writing only. If the file does not exist, it is created. If it exists, it is neither truncated (as opposed to ‘w’ ), nor the call to this function fails (as is the case with ‘x’ ). The file pointer is positioned on the beginning of the file. This may be useful if it’s desired to get an advisory lock (see flock()) before attempting to modify the file, as using ‘w’ could truncate the file before the lock was obtained (if truncation is desired, ftruncate() can be used after the lock is requested). |
‘c+’ | Open the file for reading and writing; otherwise it has the same behavior as ‘c’ . |
‘e’ | Set close-on-exec flag on the opened file descriptor. Only available in PHP compiled on POSIX.1-2008 conform systems. |
Note:
Different operating system families have different line-ending conventions. When you write a text file and want to insert a line break, you need to use the correct line-ending character(s) for your operating system. Unix based systems use \n as the line ending character, Windows based systems use \r\n as the line ending characters and Macintosh based systems (Mac OS Classic) used \r as the line ending character.
If you use the wrong line ending characters when writing your files, you might find that other applications that open those files will «look funny».
Windows offers a text-mode translation flag ( ‘t’ ) which will transparently translate \n to \r\n when working with the file. In contrast, you can also use ‘b’ to force binary mode, which will not translate your data. To use these flags, specify either ‘b’ or ‘t’ as the last character of the mode parameter.
The default translation mode is ‘b’ . You can use the ‘t’ mode if you are working with plain-text files and you use \n to delimit your line endings in your script, but expect your files to be readable with applications such as old versions of notepad. You should use the ‘b’ in all other cases.
If you specify the ‘t’ flag when working with binary files, you may experience strange problems with your data, including broken image files and strange problems with \r\n characters.
Note:
For portability, it is also strongly recommended that you re-write code that uses or relies upon the ‘t’ mode so that it uses the correct line endings and ‘b’ mode instead.
Note: The mode is ignored for php://output , php://input , php://stdin , php://stdout , php://stderr and php://fd stream wrappers.
The optional third use_include_path parameter can be set to ‘1’ or true if you want to search for the file in the include_path, too.
Return Values
Returns a file pointer resource on success, or false on failure