fopen

(PHP 3, PHP 4, PHP 5)

fopen -- 開啟檔案或者 URL

說明

resource fopen ( string filename, string mode [, bool use_include_path [, resource zcontext]] )

fopen() 將 filename 指定的名字資源繫結到一個流上。如果 filename 是 "scheme://..." 的格式，則被當成一個 URL，PHP 將搜尋協議處理器（也被稱為封裝協議）來處理此模式。如果該協議尚未註冊封裝協議，PHP 將發出一條訊息來幫助檢查指令碼中潛在的問題並將 filename 當成一個普通的檔名繼續執行下去。

如果 PHP 認為 filename 指定的是一個本地檔案，將嘗試在該檔案上開啟一個流。該檔案必須是 PHP 可以訪問的，因此需要確認檔案訪問許可權允許該訪問。如果激活了安全模式或者 open_basedir 則會應用進一步的限制。

如果 PHP 認為 filename 指定的是一個已註冊的協議，而該協議被註冊為一個網路 URL，PHP 將檢查並確認 allow_url_fopen 已被啟用。如果關閉了，PHP 將發出一個警告，而 fopen 的呼叫則失敗。

注意: 所支援的協議列表見附錄 N。某些協議（也被稱為 wrappers）支援 context 和／或 php.ini 選項。參見相應的頁面哪些選項可以被設定（例如 php.ini 中用於 http wrapper 的 user_agent 值）。

注意: 對 context 的支援是 PHP 5.0.0 新增的。有關 context 的說明見參考 CLIX, Stream Functions。

注意: 自 PHP 4.3.2 起，對所有區別二進位制和文字模式的平臺預設模式都被設為二進位制模式。如果在升級後腳本碰到問題，嘗試暫時使用 't' 標記，直到所有的指令碼都照以下所說的改為更具移植性以後。

mode 引數指定了所要求到該流的訪問型別。可以是以下：

表 1. fopen() 中 mode 的可能值列表

mode

說明

'r'

只讀方式開啟，將檔案指標指向檔案頭。

'r+'

讀寫方式開啟，將檔案指標指向檔案頭。

'w'

寫入方式開啟，將檔案指標指向檔案頭並將檔案大小截為零。如果檔案不存在則嘗試建立之。

'w+'

讀寫方式開啟，將檔案指標指向檔案頭並將檔案大小截為零。如果檔案不存在則嘗試建立之。

'a'

寫入方式開啟，將檔案指標指向檔案末尾。如果檔案不存在則嘗試建立之。

'a+'

讀寫方式開啟，將檔案指標指向檔案末尾。如果檔案不存在則嘗試建立之。

'x'

建立並以寫入方式開啟，將檔案指標指向檔案頭。如果檔案已存在，則 fopen() 呼叫失敗並返回 FALSE，並生成一條 E_WARNING 級別的錯誤資訊。如果檔案不存在則嘗試建立之。這和給 底層的 open(2) 系統呼叫指定 O_EXCL|O_CREAT 標記是等價的。此選項被 PHP 4.3.2 以及以後的版本所支援，僅能用於本地檔案。

'x+'

建立並以讀寫方式開啟，將檔案指標指向檔案頭。如果檔案已存在，則 fopen() 呼叫失敗並返回 FALSE，並生成一條 E_WARNING 級別的錯誤資訊。如果檔案不存在則嘗試建立之。這和給 底層的 open(2) 系統呼叫指定 O_EXCL|O_CREAT 標記是等價的。此選項被 PHP 4.3.2 以及以後的版本所支援，僅能用於本地檔案。

注意: 不同的作業系統家族具有不同的行結束習慣。當寫入一個文字檔案並想插入一個新行時，需要使用符合作業系統的行結束符號。基於 Unix 的系統使用 n 作為行結束字元，基於 Windows 的系統使用 rn 作為行結束字元，基於 Macintosh 的系統使用 r 作為行結束字元。

如果寫入檔案時使用了錯誤的行結束符號，則其它應用程式開啟這些檔案時可能會表現得很怪異。

Windows 下提供了一個文字轉換標記（'t'）可以透明地將 n 轉換為 rn。與此對應還可以使用 'b' 來強制使用二進位制模式，這樣就不會轉換資料。要使用這些標記，要麼用 'b' 或者用 't' 作為 mode 引數的最後一個字元。

預設的轉換模式依賴於 SAPI 和所使用的 PHP 版本，因此為了便於移植鼓勵總是指定恰當的標記。如果是操作純文字檔案並在指令碼中使用了 n 作為行結束符，但還要期望這些檔案可以被其它應用程式例如 Notepad 讀取，則在 mode 中使用 't'。在所有其它情況下使用 'b'。

在操作二進位制檔案時如果沒有指定 'b' 標記，可能會碰到一些奇怪的問題，包括壞掉的圖片檔案以及關於 rn 字元的奇怪問題。

注意: 為移植性考慮，強烈建議在用 fopen() 開啟檔案時總是使用 'b' 標記。

注意: 再一次，為移植性考慮，強烈建議你重寫那些依賴於 't' 模式的程式碼使其使用正確的行結束符並改成 'b' 模式。

如果也需要在 include_path 中搜尋檔案的話，可以將可選的第三個引數 use_include_path 設為 '1' 或 TRUE。

如果開啟失敗，本函式返回 FALSE。

例 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:[email protected]/somefile.txt", "w");
?>

如果在用伺服器模組版本的 PHP 時在開啟和寫入檔案上遇到問題，記住要確保所使用的檔案是伺服器程序所能夠訪問的。

在 Windows 平臺上，要小心轉義檔案路徑中的每個反斜線，或者用斜線。

<?php
$handle = fopen("c:\data\info.txt", "r");
?>

警告

當使用 SSL 時，Microsoft IIS 將違反協議不傳送 close_notify 標記就關閉連線。PHP 將在到達資料尾端時報告 "SSL: Fatal Protocol Error"。要繞過此問題，應將 error_reporting 級別降低為不包括警告。PHP 4.3.7 及更高版本可以在當使用 https:// 封裝協議開啟流的時候檢測出有此問題的 IIS 伺服器並抑制警告。如果使用 fsockopen() 來建立一個 ssl:// 套接字，則需要自己檢測並抑制警告資訊。

注意: 當安全模式被啟用時，PHP 將檢查被操作的目錄是否和正在執行的指令碼有相同的 UID（所有者）。