PHP でファイルを読み取る一般的な方法

将来簡単に参照できるように、PHP でファイルを読み取るいくつかの方法を整理しました。

1.fread

string fread ( int $handle , int $length )

fread() は、handle が指すファイルから最大 length バイトを読み取ります。この関数は、最大 length バイトの読み取り後、または EOF に達したとき、または (ネットワーク ストリームの場合) パケットが使用可能になったとき、または (ユーザー空間ストリームを開いた後) 8192 バイトの読み取りが完了したときに呼び出されます。どの条件が最初に発生したかに応じて異なります。

fread()は読み取った文字列を返し、エラーが発生した場合はFALSEを返します。

<?php <br>    <span style="color: #800080;">$filename</span> = "/usr/local/something.txt";<br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>(<span style="color: #800080;">$filename</span>, "r");<span style="color: #008000;">//</span><span style="color: #008000;">读取二进制文件时，需要将第二个参数设置成'rb'<br>    <br>    //通过filesize获得文件大小，将整个文件一下子读到一个字符串中</span><span style="color: #008000;"><br></span>    <span style="color: #800080;">$contents</span> = <span style="color: #008080;">fread</span>(<span style="color: #800080;">$handle</span>, <span style="color: #008080;">filesize</span> (<span style="color: #800080;">$filename</span>));<br>    <span style="color: #008080;">fclose</span>(<span style="color: #800080;">$handle</span>);<br>?>

読み込むファイルがローカルの通常ファイルではなく、リモートファイルやストリームファイルの場合、filesize ではこれらのファイルのサイズが取得できないため、この方法は使用できません。このとき、feof() または fread() の戻り値を使用して、ファイルの終端を読み取ったかどうかを判断する必要があります。

例:

<?php <br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>('http://www.baidu.com', 'r');<br>    <span style="color: #800080;">$content</span> = '';<br>    <span style="color: #0000ff;">while</span>(!<span style="color: #008080;">feof</span>(<span style="color: #800080;">$handle</span>)){<br>        <span style="color: #800080;">$content</span> .= <span style="color: #008080;">fread</span>(<span style="color: #800080;">$handle</span>, 8080);<br>    }<br>    <span style="color: #0000ff;">echo</span> <span style="color: #800080;">$content</span>;<br>    <span style="color: #008080;">fclose</span>(<span style="color: #800080;">$handle</span>);<br>?>

または:

<?php <br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>('http://www.baidu.com', 'r');<br>    <span style="color: #800080;">$content</span> = '';<br>    <span style="color: #0000ff;">while</span>(<span style="color: #0000ff;">false</span> != (<span style="color: #800080;">$a</span> = <span style="color: #008080;">fread</span>(<span style="color: #800080;">$handle</span>, 8080))){<span style="color: #008000;">//</span><span style="color: #008000;">返回false表示已经读取到文件末尾</span><span style="color: #008000;"><br></span>        <span style="color: #800080;">$content</span> .= <span style="color: #800080;">$a</span>;<br>    }<br>    <span style="color: #0000ff;">echo</span> <span style="color: #800080;">$content</span>;<br>    <span style="color: #008080;">fclose</span>(<span style="color: #800080;">$handle</span>);<br>?>

2.fgets

string fgets ( int $handle [, int $length ] )

fgets() は、handle が指すファイルから 1 行を読み取り、最大 length - 1 バイトの長さの文字列を返します。改行文字 (戻り値に含まれる)、EOF、または長さ - 1 バイト (いずれか最初に発生した方) が読み取られたときに停止します。長さが指定されていない場合、デフォルトは 1K、つまり 1024 バイトになります。

<?php <br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>('./file.txt', 'r');<br>    <span style="color: #0000ff;">while</span>(!<span style="color: #008080;">feof</span>(<span style="color: #800080;">$handle</span>)){<br>        <span style="color: #0000ff;">echo</span> <span style="color: #008080;">fgets</span>(<span style="color: #800080;">$handle</span>, 1024);<br>    }<br>    <span style="color: #008080;">fclose</span>(<span style="color: #800080;">$handle</span>);<br>?>

注: PHP 4.2.0 以降、length パラメータはオプションになります。省略した場合、行の長さは 1024 であるとみなされます。 PHP 4.3 以降、length を省略すると、行の終わりまでストリームからの読み取りが継続されます。ファイル内のほとんどの行が 8KB を超える場合は、スクリプトで最大行長を指定すると、リソースをより効率的に利用できます。 PHP 4.3 以降、この関数はバイナリ ファイルに対して安全に使用できます。以前のバージョンにはありません。

3.fgetss

string fgetss ( resource $handle [, int $length [, string $allowable_tags ]] )

fgets と同じ機能ですが、fgetss は読み取ったテキストから HTML タグと PHP タグを削除しようとします。オプションの 3 番目のパラメータを使用して、削除しないタグを指定できます。

<?php <br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>('./file.txt', 'r');<br>    <span style="color: #0000ff;">while</span>(!<span style="color: #008080;">feof</span>(<span style="color: #800080;">$handle</span>)){<br>        <span style="color: #0000ff;">echo</span> <span style="color: #008080;">fgetss</span>(<span style="color: #800080;">$handle</span>, 1024, '<br>');<br>    }<br>    <span style="color: #008080;">fclose</span>(<span style="color: #800080;">$handle</span>);<br>?>

4.ファイル

array file (string $filename [, int $use_include_path [, resource $context ]] )
ファイルの内容を配列に読み込みます (配列の各要素)エントリは、改行を含むファイル内の行に対応します。行終了記号が必要ない場合は、rtrim() 関数を使用して改行文字を除外できます。

<?php <br>    <span style="color: #800080;">$a</span> = <span style="color: #008080;">file</span>('./file.txt');<br>    <span style="color: #0000ff;">foreach</span>(<span style="color: #800080;">$a</span> <span style="color: #0000ff;">as</span> <span style="color: #800080;">$line</span> => <span style="color: #800080;">$content</span>){<br>        <span style="color: #0000ff;">echo</span> 'line '.(<span style="color: #800080;">$line</span> + 1).':'.<span style="color: #800080;">$content</span>;<br>    }<br>?>

5.readfile

int readfile ( string $filename [, bool $use_include_path [, resource $context ]] )

ファイルを読み取り、出力バッファに書き込みます。ファイルから読み取られたバイト数を返します。 @readfile() として呼び出されない限り、エラー時に FALSE を返し、エラー メッセージを表示します。

<?php <br>    <span style="color: #800080;">$size</span> = <span style="color: #008080;">readfile</span>('./file.txt');<br>    <span style="color: #0000ff;">echo</span> <span style="color: #800080;">$size</span>;<br>?>

6.file_get_contents

string file_get_contents ( string $filename [, bool $use_include_path [, resource $context [, int $offset [, int $maxlen ]]]] )

ファイルを文字列に読み取ります。 3 番目のパラメータ $context は、リモート ファイルにアクセスするときのタイムアウトの設定など、いくつかのパラメータを設定するために使用できます。

さらに、file_get_contents は上記の関数よりもパフォーマンスがはるかに優れているため、file_get_contents を最初に使用する必要があります。ただし、readfile は fopen を呼び出す必要がないため、file_get_contents(?) よりもパフォーマンスが優れているようです。

<?php <br>    <span style="color: #800080;">$ctx</span> = <span style="color: #008080;">stream_context_create</span>(<span style="color: #0000ff;">array</span>( <br>        'http' => <span style="color: #0000ff;">array</span>( <br>            'timeout' => 1    <span style="color: #008000;">//</span><span style="color: #008000;">设置超时</span><span style="color: #008000;"><br></span>            ) <br>        ) <br>    ); <br>    <span style="color: #0000ff;">echo</span> <span style="color: #008080;">file_get_contents</span>("http://www.baidu.com/", 0, <span style="color: #800080;">$ctx</span>); <br>?>

7.fパススルー

int fpassthru ( resource $handle )

指定されたファイル ポインターを現在位置から EOF まで読み取り、結果を出力バッファーに書き込みます。

<?php <br>    <span style="color: #008080;">header</span>("Content-Type:text/html;charset=utf-8"); <br>    <span style="color: #800080;">$handle</span> = <span style="color: #008080;">fopen</span>('./test2.php', 'r');<br>    <span style="color: #008080;">fseek</span>(<span style="color: #800080;">$handle</span>, 1024);<span style="color: #008000;">//</span><span style="color: #008000;">将指针定位到1024字节处</span><span style="color: #008000;"><br></span>    <span style="color: #008080;">fpassthru</span>(<span style="color: #800080;">$handle</span>);<br>?>

 

8.parse_ini_file

　　array parse_ini_file ( string $filename [, bool $process_sections ] )

　　parse_ini_file() 载入一个由 filename 指定的 ini 文件，并将其中的设置作为一个联合数组返回。如果将最后的 process_sections 参数设为 TRUE，将得到一个多维数组，包括了配置文件中每一节的名称和设置。process_sections 的默认值是 FALSE。

　　注意：

1. 如果 ini 文件中的值包含任何非字母数字的字符，需要将其括在双引号中（"）。
2. 有些保留字不能作为 ini 文件中的键名，包括：null，yes，no，true 和 false。值为 null，no 和 false 等效于 ""，值为 yes 和 true 等效于 "1"。字符 {}|&~![()" 也不能用在键名的任何地方，而且这些字符在选项值中有着特殊的意义。

test.ini文件内容：

; This is a sample configuration <span style="color: #008080;">file</span><br>; Comments start with ';', <span style="color: #0000ff;">as</span> in php.ini<br><br>[first_section]<br>one = 1<br>five = 5<br>animal = BIRD<br><br>[second_section]<br>path = "/usr/local/bin"<br>URL = "http://www.example.com/~username

test.php内容：

<?php <br>    <span style="color: #800080;">$config</span> = <span style="color: #008080;">parse_ini_file</span>('./test.ini', ture);<br>    <span style="color: #008080;">print_r</span>(<span style="color: #800080;">$config</span>);<br>?>

输出内容：

Array<br>(<br>    [first_section] => Array<br>        (<br>            [one] => 1<br>            [five] => 5<br>            [animal] => BIRD<br>        )<br><br>    [second_section] => Array<br>        (<br>            [path] => /usr/local/bin<br>            [URL] => http://www.example.com/~username<br>        )<br><br>)

 

 

 

几个注意事项：

　　1. 鼓励在处理二进制文件时使用 b 标志，即使系统并不需要，这样可以使脚本的移植性更好。 

　　2. allow_url_fopen选项激活了 URL 形式的 fopen 封装协议使得可以访问 URL 对象例如文件。默认的封装协议提供用 ftp 和 http 协议来访问远程文件，一些扩展库例如 zlib 可能会注册更多的封装协议。出于安全性考虑，此选项只能在 php.ini 中设置。

　　3. 如果要打开有特殊字符的 URL （比如说有空格），就需要使用 urlencode() 进行 URL 编码。