【PHP8.x】FILEINFO_MIME定数の使い方

Copy
1<?php
2
3/**
4 * 指定されたファイルのMIMEタイプを検出して返します。
5 *
6 * この関数は、`FILEINFO_MIME` 定数を使用してファイルの内容からMIMEタイプを判別します。
7 *
8 * @param string $filePath MIMEタイプを検出するファイルのパス。
9 * @return string|null 検出されたMIMEタイプ（例: "text/plain; charset=us-ascii"）を返します。
10 *                     fileinfo拡張機能の初期化に失敗した場合や、MIMEタイプを検出できなかった場合はnullを返します。
11 */
12function getFileMimeType(string $filePath): ?string
13{
14    // fileinfo リソースを開き、MIMEタイプを検出するためのフラグとして FILEINFO_MIME を指定します。
15    // FILEINFO_MIME 定数は、ファイルの内容に基づいてMIMEタイプを返すように fileinfo 拡張機能に指示します。
16    $finfo = finfo_open(FILEINFO_MIME);
17
18    if (!$finfo) {
19        // finfo_open() が失敗した場合、fileinfo 拡張機能が有効になっていないか、
20        // 必要なマジックデータベースファイルが見つからない可能性があります。
21        error_log("エラー: fileinfo 拡張機能の初期化に失敗しました。PHP の設定を確認してください。");
22        return null;
23    }
24
25    // 指定されたファイルのMIMEタイプを検出します。
26    $mimeType = finfo_file($finfo, $filePath);
27
28    // 開いた finfo リソースを閉じます。
29    finfo_close($finfo);
30
31    // finfo_file() は失敗した場合に false を返すため、null に変換します。
32    return ($mimeType !== false) ? $mimeType : null;
33}
34
35// --- サンプルコードの実行例 ---
36
37// MIMEタイプを検出するためのテストファイルを作成します。
38$testFilePath = 'sample.txt';
39$fileContent = 'これはMIMEタイプを検出するためのテキストファイルです。';
40if (file_put_contents($testFilePath, $fileContent) === false) {
41    echo "エラー: テストファイルの作成に失敗しました。\n";
42    exit(1);
43}
44echo "テストファイル '{$testFilePath}' を作成しました。\n";
45
46// 作成したファイルのMIMEタイプを取得します。
47$detectedMimeType = getFileMimeType($testFilePath);
48
49if ($detectedMimeType !== null) {
50    echo "ファイル '{$testFilePath}' のMIMEタイプ: {$detectedMimeType}\n";
51} else {
52    echo "ファイル '{$testFilePath}' のMIMEタイプを検出できませんでした。\n";
53}
54
55// テストファイルをクリーンアップ（削除）します。
56if (file_exists($testFilePath)) {
57    unlink($testFilePath);
58    echo "テストファイル '{$testFilePath}' を削除しました。\n";
59}
60
61?>

PHPのFILEINFO_MIME定数は、fileinfo拡張機能を用いてファイルのMIMEタイプを検出する際に使用される特別なフラグです。この定数を指定すると、ファイルの内容を解析し、その種類に合致するMIMEタイプ（例: "text/plain" や "image/jpeg"）を判別するようfileinfo拡張機能に指示します。

提供されたサンプルコードのgetFileMimeType関数は、指定されたファイルのMIMEタイプを検出することを目的としています。この関数は引数として、MIMEタイプを調べたいファイルのパスを文字列$filePathで受け取ります。関数内部では、finfo_open(FILEINFO_MIME)によりFILEINFO_MIME定数を指定してfileinfoリソースが初期化され、そのリソースを用いてfinfo_file関数でMIMEタイプが取得されます。処理の完了後にはfinfo_closeでリソースを解放します。戻り値は、検出されたMIMEタイプを文字列として返すか、MIMEタイプの検出に失敗した場合にはnullを返します。例えば、fileinfo拡張機能が正しく設定されていない場合などにnullが返されることがあります。

サンプルコードの実行例では、まず一時的なテキストファイルが作成されます。次に、この作成されたファイルのMIMEタイプがgetFileMimeType関数を呼び出して検出され、その結果が画面に表示されます。最後に、テストで作成したファイルは削除され、処理が終了します。

Copy
1<?php
2
3/**
4 * 指定されたファイルのMIMEタイプを取得します。
5 *
6 * この関数は、ファイル情報拡張モジュール (Fileinfo extension) を使用して、
7 * ファイルの内容に基づいてそのMIMEタイプを判別します。
8 * FILEINFO_MIME 定数を使用することで、MIMEタイプ情報のみを取得するように指定しています。
9 *
10 * @param string $filePath MIMEタイプを取得するファイルのパス。
11 * @return string|null 取得したMIMEタイプ（例: "text/plain; charset=us-ascii"）。
12 *                     ファイルの読み込みや処理に失敗した場合は null を返します。
13 */
14function getFileMimeType(string $filePath): ?string
15{
16    // 1. ファイルが存在するかどうかを確認します。
17    if (!file_exists($filePath)) {
18        echo "エラー: ファイル '{$filePath}' が見つかりません。\n";
19        return null;
20    }
21
22    // 2. finfo_open() を使ってファイル情報リソースを作成します。
23    //    FILEINFO_MIME 定数をフラグとして渡し、MIMEタイプ情報のみを取得するように指定します。
24    $finfo = finfo_open(FILEINFO_MIME);
25
26    // 3. finfo_open() が失敗した場合のハンドリング。
27    //    ファイル情報拡張モジュールが利用できない場合などに発生することがあります。
28    if (!$finfo) {
29        echo "エラー: finfo_open() の初期化に失敗しました。\n";
30        return null;
31    }
32
33    // 4. finfo_file() を使って指定されたファイルのMIMEタイプを取得します。
34    //    第1引数に finfo_open() で作成したリソース、第2引数にファイルのパスを渡します。
35    $mimeType = finfo_file($finfo, $filePath);
36
37    // 5. finfo_close() を使ってファイル情報リソースを解放します。
38    //    リソースのリークを防ぐために、処理が完了したら必ず閉じます。
39    finfo_close($finfo);
40
41    return $mimeType;
42}
43
44// --------------------------------------------------------------------------
45// サンプルコードの実行例
46// --------------------------------------------------------------------------
47
48// MIMEタイプを取得するためのテストファイルを作成します。
49// file_put_contents() は、指定されたファイルに文字列を書き込みます。
50// このファイルは後でMIMEタイプを調べるために使用します。
51$testFileName = 'sample_document.txt';
52file_put_contents($testFileName, 'このファイルはテキスト形式のサンプルです。');
53
54echo "--- ファイルMIMEタイプ取得の実行 ---" . PHP_EOL;
55echo "対象ファイル: " . $testFileName . PHP_EOL;
56
57// 作成したファイルのMIMEタイプを取得し、結果を表示します。
58$mimeType = getFileMimeType($testFileName);
59
60if ($mimeType !== null) {
61    echo "取得されたMIMEタイプ: " . $mimeType . PHP_EOL;
62} else {
63    echo "MIMEタイプの取得に失敗しました。" . PHP_EOL;
64}
65
66// 別種のファイル（例: 画像）のMIMEタイプを調べる場合は、
67// 以下の行をコメント解除し、適切な画像ファイルパスを指定してください。
68/*
69$imageFileName = 'path/to/your/image.jpg'; // 実際の画像ファイルのパスに置き換えてください
70echo PHP_EOL . "--- 別のファイルのMIMEタイプ取得例 ---" . PHP_EOL;
71echo "対象ファイル: " . $imageFileName . PHP_EOL;
72$imageMimeType = getFileMimeType($imageFileName);
73if ($imageMimeType !== null) {
74    echo "取得されたMIMEタイプ: " . $imageMimeType . PHP_EOL;
75} else {
76    echo "MIMEタイプの取得に失敗しました。" . PHP_EOL;
77}
78*/
79
80// テストファイルのクリーンアップ（削除）
81// unlink() は、指定されたファイルを削除します。
82if (file_exists($testFileName)) {
83    unlink($testFileName);
84    echo PHP_EOL . "テストファイル '{$testFileName}' を削除しました。" . PHP_EOL;
85}
86
87echo "--- 処理終了 ---" . PHP_EOL;
88
89?>

このPHPコードは、指定されたファイルのMIMEタイプを判別し取得する手順を示しています。MIMEタイプとは、ファイルの種類（例：テキストファイル、画像ファイルなど）を識別するための標準的な形式です。

主要な関数であるgetFileMimeTypeは、MIMEタイプを取得したいファイルのパス（$filePath）を引数として受け取ります。この関数は、PHPのファイル情報拡張モジュール（Fileinfo extension）を利用し、ファイルの内容に基づいてMIMEタイプを特定します。戻り値は、取得されたMIMEタイプを示す文字列（例: "text/plain; charset=us-ascii"）か、ファイルが見つからない、または処理に失敗した場合にnullです。

MIMEタイプ情報を取得する際に重要なのが、FILEINFO_MIME定数です。これはfinfo_open関数のフラグとして使用され、ファイルからMIMEタイプ情報のみを抽出するように指定します。FILEINFO_MIME定数自体は引数を取らず、整数値を返すもので、特定の処理モードを指示する役割があります。まずfinfo_open(FILEINFO_MIME)でファイル情報リソースを初期化し、次にfinfo_fileで指定されたファイルのMIMEタイプを取得します。処理の完了後には、リソースのリークを防ぐためfinfo_closeでリソースを解放することが重要です。

サンプルコードの実行例では、file_put_contents関数で一時的なテキストファイルを作成し、そのMIMEタイプをgetFileMimeType関数を使って取得しています。処理後には、作成したテストファイルがunlink関数で削除され、環境がクリーンに保たれます。このようにして、ファイルのMIMEタイプを安全かつ効率的に判別できます。