file
(PHP 4, PHP 5)
file — ファイル全体を読み込んで配列に格納する
説明
ファイル全体を配列に読み込みます。
注意:
ファイルの内容を文字列として返すには file_get_contents() を使用します。
パラメータ
- filename
-
ファイルへのパス。
ヒントfopen wrappers が有効の場合、この関数のファイル名として URL を使用することができます。ファイル名の指定方法に関する詳細は fopen() を参照ください。 サポートするプロトコル/ラッパー には、さまざまなラッパーの機能やその使用法、 提供される定義済み変数などの情報がまとめられています。
- flags
-
オプションのパラメータ flags は、以下の定数のうちのひとつ、あるいは複数の組み合わせとなります。
- FILE_USE_INCLUDE_PATH
- include_path のファイルを探します。
- FILE_IGNORE_NEW_LINES
- 配列の各要素の最後に改行文字を追加しません。
- FILE_SKIP_EMPTY_LINES
- 空行を読み飛ばします。
- context
-
stream_context_create() 関数で作成したコンテキストリソース。
注意: コンテキストのサポートは、 PHP 5.0.0 で追加されました。contexts の説明に関しては、 ストリーム 関数 を参照してください。
返り値
ファイルを配列に入れて返します。 配列の各要素はファイルの各行に対応します。改行記号はついたままとなります。 失敗すると file() は FALSE を返します。
注意:
FILE_IGNORE_NEW_LINES を指定しない限り、 配列に取り込まれた各行は行末文字も含みます。 行末文字を取り除きたい場合には rtrim() を使用する必要があります。
注意: マッキントッシュコンピュータ上で作成されたファイルを読み込む際に、 PHP が行末を認識できないという問題が発生した場合、 実行時の設定オプションauto_detect_line_endings を有効にする必要が生じるかもしれません。
変更履歴
| バージョン | 説明 |
|---|---|
| 5.0.0 | context パラメータが追加されました。 |
| 5.0.0 | PHP 5.0.0 より前のバージョンでは、パラメータ flags でカバーしているのは include_path の設定だけでした。これを有効にするには 1 を指定します。 |
| 4.3.0 | file() はバイナリセーフとなりました。 |
例
例1 file() の例
<?php
// ファイルの内容を配列に取り込みます。
// この例ではHTTPを通してURL上のHTMLソースを取得します。
$lines = file('http://www.example.com/');
// 配列をループしてHTMLをHTMLソースとして表示し、行番号もつけます。
foreach ($lines as $line_num => $line) {
echo "Line #<b>{$line_num}</b> : " . htmlspecialchars($line) . "<br />\n";
}
// 他の例として、Webページを文字列に取り込みます。file_get_contents()も参照してください。
$html = implode('', file('http://www.example.com/'));
// オプションのパラメータは PHP 5 以降で使用できます
$trimmed = file('somefile.txt', FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
?>
注意
IIS のような、いくつかの標準に 対応してない Web サーバは、PHP に警告を発生させるような手順でデータを送信します。 このようなサーバを使用する場合は、 error_reporting を警告を発生しないレベルまで小さくする必要があります。 PHP 4.3.7 以降では、https:// ラッパーでストリームをオープンする際に バグがある IIS サーバソフトウエアを検出することができ、この警告を抑制することができます。 あなたが ssl:// ソケットを作成するために fsockopen() を使用している場合、 自らこの警告を検出し、抑制する必要があります。
参考
- readfile() - ファイルを出力する
- fopen() - ファイルまたは URL をオープンする
- fsockopen() - インターネット接続もしくは Unix ドメインソケット接続をオープンする
- popen() - プロセスへのファイルポインタをオープンする
- file_get_contents() - ファイルの内容を全て文字列に読み込む
- include()
- stream_context_create() - ストリームコンテキストを作成する
