【PHP8.x】finfo::file()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルが存在するかを確認し、存在すればそのMIMEタイプを返す関数
7 *
8 * @param string $filename ファイルへのパス
9 * @return void
10 */
11function printMimeType(string $filename): void
12{
13    // file_exists() を使って、ファイルまたはディレクトリの存在を確認します。
14    if (file_exists($filename) && is_file($filename)) {
15        echo "ファイル '{$filename}' が見つかりました。" . PHP_EOL;
16
17        // finfo クラスのインスタンスを生成します。
18        // FILEINFO_MIME_TYPE は、MIMEタイプを文字列で返すよう指定する定数です。
19        $finfo = new finfo(FILEINFO_MIME_TYPE);
20
21        // finfo::file() メソッドで、指定したファイルのMIMEタイプを取得します。
22        // 取得に失敗した場合は false が返ります。
23        $mimeType = $finfo->file($filename);
24
25        if ($mimeType !== false) {
26            echo "MIMEタイプ: " . $mimeType . PHP_EOL;
27        } else {
28            echo "MIMEタイプの取得に失敗しました。" . PHP_EOL;
29        }
30    } else {
31        echo "ファイル '{$filename}' は存在しないか、ディレクトリです。" . PHP_EOL;
32    }
33}
34
35// --- 実行例 ---
36
37// テスト用のファイルを作成
38$testFile = 'test.txt';
39file_put_contents($testFile, 'Hello, PHP!');
40
41// 存在するファイルのMIMEタイプを取得
42printMimeType($testFile);
43
44echo PHP_EOL;
45
46// 存在しないファイルのMIMEタイプを取得
47printMimeType('non_existent_file.txt');
48
49// テスト用のファイルを削除
50unlink($testFile);
51
52?>

このPHPサンプルコードは、finfo::file()メソッドを使用して、指定されたファイルのMIMEタイプを取得し表示する例です。

はじめにfile_exists()関数を使い、そもそも対象のファイルが存在するのかを安全に確認しています。存在しないファイルに対して処理を行うとエラーになるため、これは重要な事前チェックです。

ファイルの存在が確認できた後、new finfo(FILEINFO_MIME_TYPE)という記述でfinfoクラスのインスタンスを生成します。このとき、引数に定数FILEINFO_MIME_TYPEを指定することで、MIMEタイプ（例: text/plain）を文字列として取得するように設定しています。

次に、$finfo->file($filename)のようにfile()メソッドを呼び出します。第一引数には、調べたいファイルのパスを指定します。このメソッドは、ファイルの中身を解析し、成功した場合はMIMEタイプを文字列で返します。一方、何らかの理由で情報の取得に失敗した場合はfalseを返します。そのため、サンプルコードでは戻り値がfalseでないことを確認してから結果を出力しています。

Copy
1<?php
2
3/**
4 * 指定されたファイルのMIMEタイプを調べて表示する関数
5 *
6 * このサンプルでは、まずテスト用のテキストファイルを作成します。
7 * 次に、finfoクラスのインスタンスを生成し、file()メソッドを使って
8 * そのファイルのMIMEタイプ（この場合は 'text/plain'）を特定して出力します。
9 *
10 * file_get_contents() はファイルの内容を文字列として取得しますが、
11 * finfo::file() はファイルそのものの種類（MIMEタイプなど）を
12 * ファイルパスから直接調べるために使われます。
13 *
14 * @param string $filepath MIMEタイプを調べるファイルのパス
15 * @return void
16 */
17function displayMimeType(string $filepath): void
18{
19    // finfoオブジェクトをMIMEタイプを返すモードで作成
20    // finfo_open() のオブジェクト指向ラッパーです
21    $finfo = new finfo(FILEINFO_MIME_TYPE);
22
23    // ファイルが存在するかチェック
24    if (!file_exists($filepath)) {
25        echo "エラー: ファイル '{$filepath}' が見つかりません。\n";
26        return;
27    }
28
29    // finfo::file() メソッドでファイルのMIMEタイプを取得
30    // 失敗した場合は false が返ります
31    $mimeType = $finfo->file($filepath);
32
33    if ($mimeType === false) {
34        echo "エラー: ファイル '{$filepath}' のMIMEタイプを特定できませんでした。\n";
35    } else {
36        echo "ファイル '{$filepath}' のMIMEタイプは: {$mimeType}\n";
37    }
38}
39
40// --- 実行コード ---
41
42// サンプル用のファイル名
43$filename = 'sample.txt';
44
45// サンプル用のファイルを作成（file_put_contentsはfile_get_contentsの逆の操作）
46// このファイルの内容がMIMEタイプ特定に影響します
47$fileContent = 'これはPHPのテストファイルです。';
48file_put_contents($filename, $fileContent);
49
50// 作成したファイルのMIMEタイプを調べて表示
51displayMimeType($filename);
52
53// テスト用に作成したファイルを削除
54unlink($filename);
55
56?>

finfo::file()メソッドは、引数で指定したファイルの情報を文字列として取得します。このメソッドは、アップロードされたファイルが意図した形式（画像、PDFなど）であるかを確認するなど、ファイルの種類を判別する目的で広く利用されます。

まず new finfo() でオブジェクトを生成します。このとき、コンストラクタの引数に FILEINFO_MIME_TYPE のような定数を渡すことで、取得したい情報の種類を指定します。サンプルコードでは、ファイルの種類を表すMIMEタイプを取得する設定にしています。

次に、生成したオブジェクトの file() メソッドを呼び出し、必須の第1引数 $filename に調べたいファイルのパスを渡します。処理が成功すると、指定した情報（この場合はMIMEタイプ）が文字列として返されます。ファイルの読み込みに失敗した場合は false が返るため、戻り値の型を厳密にチェックすることが重要です。

file_get_contents()がファイルの中身を文字列として取得するのに対し、finfo::file()はファイルの種類そのものを調べるという点が大きな違いです。