fread: バイナリセーフなファイルの読み込み (ファイルシステム関数) - PHPプロ！マニュアル

» 「ファイルシステム関数」に戻る

PHPマニュアル

fread: バイナリセーフなファイルの読み込み

fread

(PHP 4, PHP 5)

fread — バイナリセーフなファイルの読み込み

説明

string fread ( resource $handle , int $length )

fread() は、handle が指すファイルポインタから最高 length バイト読み込みます。以下のいずれかの条件を満たしたら、読み込みを終了します。

length バイトぶん読み込んだ
EOF (ファイルの終端) に達した
パケットが利用可能になるか、あるいはソケットのタイムアウトが発生した (ネットワークストリームの場合)
8192 バイトぶん読み込んだ (ユーザ定義ストリームをオープンした後)

パラメータ

handle: fopen() を使用して作成したファイルシステムポインタリソース。
length: 最大 length バイトまで読み込む。

返り値

読み込んだ文字列を返します。失敗した場合に FALSE を返します。

例

例1 シンプルな fread() の例

<?php
// ファイルの中身を読んで文字列に格納する
$filename = "/usr/local/something.txt";
$handle = fopen($filename, "r");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>

例2 バイナリの fread() の例

警告

バイナリとテキストファイルの形式が異なるシステム(すなわち Windows)では、fopen()の mode パラメータに 'b' を指定してファイルをオープンする必要があります。

<?php

$filename = "c:\\files\\somepic.gif";
$handle = fopen($filename, "rb");
$contents = fread($handle, filesize($filename));
fclose($handle);
?>

例3 リモートファイルの fread() の例

警告

通常のローカルファイル以外のもの、例えばリモートファイルや popen()、fsockopen() が返すストリームを読み込んでいる場合には、パケットが有効になった後に読み込みはストップします。つまり以下の例のように分割されたデータを結合すべきであるということです。

<?php
// PHP 5 以降での例
$handle = fopen("http://www.example.com/", "rb");
$contents = stream_get_contents($handle);
fclose($handle);
?>

<?php

$handle = fopen("http://www.example.com/", "rb");
$contents = '';

while (!feof($handle)) {

  $contents .= fread($handle, 8192);

}
fclose($handle);
?>

注意

注意:

ファイルの中身を文字列に格納したいだけならば、file_get_contents() を使うほうが上記の例よりも効率的です。

注意:

fread() は、ファイルポインタが現在指している位置から読み込みを開始することに注意しましょう。ポインタの現在位置を調べるには ftell() を、そしてポインタの位置を巻き戻すには rewind() を使用します。

参考

fwrite() - バイナリセーフなファイル書き込み処理
fopen() - ファイルまたは URL をオープンする
fsockopen() - インターネット接続もしくはUnix ドメインソケット接続をオープンする
popen() - プロセスへのファイルポインタをオープンする
fgets() - ファイルポインタから 1 行取得する
fgetss() - ファイルポインタから 1 行取り出し、HTML タグを取り除く
fscanf() - フォーマットに基づきファイルからの入力を処理する
file() - ファイル全体を読み込んで配列に格納する
fpassthru() - ファイルポインタ上に残っているすべてのデータを出力する
ftell() - ファイルの読み書き用ポインタの現在位置を返す
rewind() - ファイルポインタの位置を先頭に戻す

fread: バイナリセーフなファイルの読み込み (ファイルシステム関数) - PHPプロ！マニュアル