fopen
(PHP 4, PHP 5, PHP 7, PHP 8)
fopen — 打開檔案或者 URL
說明
string
$filename
,string
$mode
,bool
$use_include_path
= false,resource
$context
= ?): resource
fopen() 將
filename
指定的名字資源繫結到一個流上。
參數
-
filename
-
如果
filename
是 "scheme://..." 的格式,則被當成一個 URL,PHP 將搜索協議處理器(也被稱為封裝協議)來處理此模式。如果該協議尚未註冊封裝協議,PHP 將發出一條訊息來幫助檢查指令碼中潛在的問題並將filename
當成一個普通的檔名繼續執行下去。如果 PHP 認為
filename
指定的是一個本地檔案,將嘗試在該檔案上打開一個流。該檔案必須是 PHP 可以訪問的,因此需要確認檔案訪問許可權允許該訪問。如果啟用了 open_basedir 則會應用進一步的限制。如果 PHP 認為
filename
指定的是一個已註冊的協議,而該協議被註冊為一個網路 URL,PHP 將檢查並確認 allow_url_fopen 已被啟用。如果關閉了,PHP 將發出一個警告,而 fopen 的呼叫則失敗。注意:
所支援的協議列表見支援的協議和封裝協議。某些協議(也被稱為
wrappers
)支援context
和/或 php.ini 選項。參見相應的頁面哪些選項可以被設定(例如 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
參數指定了所要求到該流的訪問型別。可以是以下:fopen() 中 mode
的可能值列表mode
說明 'r'
只讀方式打開,將檔案指針指向檔案頭。 'r+'
讀寫方式打開,將檔案指針指向檔案頭。 'w'
寫入方式打開,將檔案指針指向檔案頭並將檔案大小截為零。如果檔案不存在則嘗試建立之。 'w+'
讀寫方式打開,將檔案指針指向檔案頭並將檔案大小截為零。如果檔案不存在則嘗試建立之。 'a'
寫入方式打開,將檔案指針指向檔案末尾。如果檔案不存在則嘗試建立之。 'a+'
讀寫方式打開,將檔案指針指向檔案末尾。如果檔案不存在則嘗試建立之。 'x'
建立並以寫入方式打開,將檔案指針指向檔案頭。如果檔案已存在,則 fopen() 呼叫失敗並返回 false
,並產生一條E_WARNING
級別的錯誤資訊。如果檔案不存在則嘗試建立之。這和給 底層的open(2)
系統呼叫指定O_EXCL|O_CREAT
標記是等價的。'x+'
建立並以讀寫方式打開,其他的行為和 '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'
.注意:
不同的操作系統家族具有不同的行結束習慣。當寫入一個文字檔案並想插入一個新行時,需要使用符合操作系統的行結束符號。基於 Unix 的系統使用
\n
作為行結束字元,基於 Windows 的系統使用\r\n
作為行結束字元,基於 Macintosh 的系統使用\r
作為行結束字元。如果寫入檔案時使用了錯誤的行結束符號,則其它應用程式打開這些檔案時可能會表現得很怪異。
Windows 下提供了一個文字轉換標記(
't'
)可以透明地將\n
轉換為\r\n
。與此對應還可以使用'b'
來強制使用二進制模式,這樣就不會轉換數據。要使用這些標記,要麼用'b'
或者用't'
作為mode
參數的最後一個字元。預設的轉換模式依賴於 SAPI 和所使用的 PHP 版本,因此爲了便於移植鼓勵總是指定恰當的標記。如果是操作純文字檔案並在指令碼中使用了
\n
作為行結束符,但還要期望這些檔案可以被其它應用程式例如 Notepad 讀取,則在 mode 中使用't'
。在所有其它情況下使用'b'
。在操作二進制檔案時如果沒有指定
'b'
標記,可能會碰到一些奇怪的問題,包括壞掉的圖片檔案以及關於\r\n
字元的奇怪問題。注意:
為移植性考慮,強烈建議在用 fopen() 打開檔案時總是使用
'b'
標記。注意:
再一次,為移植性考慮,強烈建議你重寫那些依賴於
't'
模式的程式碼使其使用正確的行結束符並改成'b'
模式。 -
use_include_path
-
如果也需要在 include_path 中搜尋檔案的話,可以將可選的第三個參數
use_include_path
設為 '1' 或true
。 -
context
-
上下文流(context stream) resource。
返回值
成功時返回檔案指針資源,如果打開失敗,本函式返回 false
。
錯誤/異常
如果打開失敗,會產生一個 E_WARNING
錯誤。可以通過 @ 來遮蔽錯誤。
更新日誌
版本 | 說明 |
---|---|
4.3.2 |
自 PHP 4.3.2
起,對所有區別二進制和文字模式的平臺預設模式都被設為二進制模式。如果在升級後腳本碰到問題,嘗試暫時使用
'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:[email protected]/somefile.txt", "w");
?>
註釋
使用 SSL 時,Microsoft IIS
會違反協議不發送close_notify
標記就關閉連線。PHP 會在到達數據尾端時報告「SSL: Fatal Protocol Error」。
要解決此問題,error_reporting 應設定為降低階別至不包含警告。
PHP 4.3.7 及更高版本可以在使用 https://
包裝器打開流時檢測出有問題的 IIS 伺服器軟體 並抑制警告。在使用
fsockopen() 建立 ssl://
套接字時, 開發者需檢測並抑制此警告。
注意:
如果在用伺服器模組版本的 PHP 時在打開和寫入檔案上遇到問題,記住要確保所使用的檔案和目錄是伺服器程序所能夠訪問的。
注意:
This function may also succeed when
filename
is a directory. If you are unsure whetherfilename
is a file or a directory, you may need to use the is_dir() function before calling fopen().
參見
- 支援的協議和封裝協議
- fclose() - 關閉一個已打開的檔案指針
- fgets() - 從檔案指針中讀取一行
- fread() - 讀取檔案(可安全用於二進制檔案)
- fwrite() - 寫入檔案(可安全用於二進制檔案)
- fsockopen() - 打開一個網路連線或者一個Unix套接字連線
- file() - 把整個檔案讀入一個陣列中
- file_exists() - 檢查檔案或目錄是否存在
- is_readable() - 判斷給定檔名是否可讀
- stream_set_timeout() - Set timeout period on a stream
- popen() - 打開程序檔案指針
- stream_context_create() - 建立資源流上下文
- umask() - 改變目前的 umask
- SplFileObject