fopen

(PHP 4, PHP 5, PHP 7, PHP 8)

fopen打開文件或者 URL

說明

fopen(
    string $filename,
    string $mode,
    bool $use_include_path = false,
    resource $context = ?
): resource

fopen()filename 指定的名字資源綁定到一個流上。

參數(shù)

filename

如果 filename 是 "scheme://..." 的格式,則被當成一個 URL,PHP 將搜索協(xié)議處理器(也被稱為封裝協(xié)議)來處理此模式。如果該協(xié)議尚未注冊封裝協(xié)議,PHP 將發(fā)出一條消息來幫助檢查腳本中潛在的問題并將 filename 當成一個普通的文件名繼續(xù)執(zhí)行下去。

如果 PHP 認為 filename 指定的是一個本地文件,將嘗試在該文件上打開一個流。該文件必須是 PHP 可以訪問的,因此需要確認文件訪問權(quán)限允許該訪問。如果激活了 open_basedir 則會應(yīng)用進一步的限制。

如果 PHP 認為 filename 指定的是一個已注冊的協(xié)議,而該協(xié)議被注冊為一個網(wǎng)絡(luò) URL,PHP 將檢查并確認 allow_url_fopen 已被激活。如果關(guān)閉了,PHP 將發(fā)出一個警告,而 fopen 的調(diào)用則失敗。

注意:

所支持的協(xié)議列表見支持的協(xié)議和封裝協(xié)議。某些協(xié)議(也被稱為 wrappers)支持 context 和/或 php.ini 選項。參見相應(yīng)的頁面哪些選項可以被設(shè)定(例如 php.ini 中用于 http wrapper 的 user_agent 值)。

On the Windows platform, be careful to escape any backslashes used in the path to the file, or use forward slashes.

<?php
$handle 
fopen("c:\\folder\\resource.txt""r");
?>

mode

mode 參數(shù)指定了所要求到該流的訪問類型??梢允且韵拢?

fopen()mode 的可能值列表
mode 說明
'r' 只讀方式打開,將文件指針指向文件頭。
'r+' 讀寫方式打開,將文件指針指向文件頭。
'w' 寫入方式打開,將文件指針指向文件頭并將文件大小截為零。如果文件不存在則嘗試創(chuàng)建之。
'w+' 讀寫方式打開,將文件指針指向文件頭并將文件大小截為零。如果文件不存在則嘗試創(chuàng)建之。
'a' 寫入方式打開,將文件指針指向文件末尾。如果文件不存在則嘗試創(chuàng)建之。
'a+' 讀寫方式打開,將文件指針指向文件末尾。如果文件不存在則嘗試創(chuàng)建之。
'x' 創(chuàng)建并以寫入方式打開,將文件指針指向文件頭。如果文件已存在,則 fopen() 調(diào)用失敗并返回 false,并生成一條 E_WARNING 級別的錯誤信息。如果文件不存在則嘗試創(chuàng)建之。這和給 底層的 open(2) 系統(tǒng)調(diào)用指定 O_EXCL|O_CREAT 標記是等價的。
'x+' 創(chuàng)建并以讀寫方式打開,其他的行為和 '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'.

注意:

不同的操作系統(tǒng)家族具有不同的行結(jié)束習(xí)慣。當寫入一個文本文件并想插入一個新行時,需要使用符合操作系統(tǒng)的行結(jié)束符號?;? Unix 的系統(tǒng)使用 \n 作為行結(jié)束字符,基于 Windows 的系統(tǒng)使用 \r\n 作為行結(jié)束字符,基于 Macintosh 的系統(tǒng)使用 \r 作為行結(jié)束字符。

如果寫入文件時使用了錯誤的行結(jié)束符號,則其它應(yīng)用程序打開這些文件時可能會表現(xiàn)得很怪異。

Windows 下提供了一個文本轉(zhuǎn)換標記('t')可以透明地將 \n 轉(zhuǎn)換為 \r\n。與此對應(yīng)還可以使用 'b' 來強制使用二進制模式,這樣就不會轉(zhuǎn)換數(shù)據(jù)。要使用這些標記,要么用 'b' 或者用 't' 作為 mode 參數(shù)的最后一個字符。

默認的轉(zhuǎn)換模式依賴于 SAPI 和所使用的 PHP 版本,因此為了便于移植鼓勵總是指定恰當?shù)臉擞?。如果是操作純文本文件并在腳本中使用了 \n 作為行結(jié)束符,但還要期望這些文件可以被其它應(yīng)用程序例如 Notepad 讀取,則在 mode 中使用 't'。在所有其它情況下使用 'b'。

在操作二進制文件時如果沒有指定 'b' 標記,可能會碰到一些奇怪的問題,包括壞掉的圖片文件以及關(guān)于 \r\n 字符的奇怪問題。

注意:

為移植性考慮,強烈建議在用 fopen() 打開文件時總是使用 'b' 標記。

注意:

再一次,為移植性考慮,強烈建議你重寫那些依賴于 't' 模式的代碼使其使用正確的行結(jié)束符并改成 'b' 模式。

use_include_path

如果也需要在 include_path 中搜尋文件的話,可以將可選的第三個參數(shù) use_include_path 設(shè)為 '1' 或 true。

context

上下文流(context stream) resource。

返回值

成功時返回文件指針資源,如果打開失敗,本函數(shù)返回 false。

錯誤/異常

如果打開失敗,會產(chǎn)生一個 E_WARNING 錯誤??梢酝ㄟ^ @ 來屏蔽錯誤。

更新日志

版本 說明
4.3.2 自 PHP 4.3.2 起,對所有區(qū)別二進制和文本模式的平臺默認模式都被設(shè)為二進制模式。如果在升級后腳本碰到問題,嘗試暫時使用 't' 標記,直到所有的腳本都照以下所說的改為更具移植性以后。
4.3.2 增加了選項 'x''x+'
5.2.6 增加了選項 'c''c+'

范例

示例 #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");
?>

注釋

警告

使用 SSL 時,Microsoft IIS 會違反協(xié)議不發(fā)送close_notify標記就關(guān)閉連接。PHP 會在到達數(shù)據(jù)尾端時報告“SSL: Fatal Protocol Error”。 要解決此問題,error_reporting 應(yīng)設(shè)定為降低級別至不包含警告。 PHP 4.3.7 及更高版本可以在使用 https:// 包裝器打開流時檢測出有問題的 IIS 服務(wù)器軟件 并抑制警告。在使用 fsockopen() 創(chuàng)建 ssl:// 套接字時, 開發(fā)者需檢測并抑制此警告。

注意:

如果在用服務(wù)器模塊版本的 PHP 時在打開和寫入文件上遇到問題,記住要確保所使用的文件和目錄是服務(wù)器進程所能夠訪問的。

注意:

This function may also succeed when filename is a directory. If you are unsure whether filename is a file or a directory, you may need to use the is_dir() function before calling fopen().

參見