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

Copy
1<?php
2
3/**
4 * 指定された画像ファイルがAVIF形式であるかどうかをチェックする関数。
5 *
6 * この関数は、PHPのgetimagesize()関数を使用して画像ファイルの情報を取得し、
7 * そのタイプがIMAGETYPE_AVIF定数と一致するかどうかを判定します。
8 * IMAGETYPE_AVIF定数は、AVIF画像フォーマットを表す整数値です。
9 *
10 * @param string $filePath チェックする画像ファイルのパス。
11 * @return void
12 */
13function checkImageAvifType(string $filePath): void
14{
15    // getimagesize() は画像のサイズと種類に関する情報を配列で返します。
16    // 戻り値のインデックス2には、IMAGETYPE_XXX 定数の一つが含まれており、
17    // 画像の形式（JPEG, PNG, GIF, AVIFなど）を示します。
18    // @getimagesize は、ファイルが見つからないなどのエラーが発生した場合に
19    // PHPのエラーメッセージの表示を抑制し、代わりにfalseを返します。
20    $imageInfo = @getimagesize($filePath);
21
22    if ($imageInfo === false) {
23        echo "エラー: ファイル '{$filePath}' の画像情報を取得できませんでした。\n";
24        echo "ファイルが存在するか、または有効な画像ファイルであるか確認してください。\n";
25        return;
26    }
27
28    $imageType = $imageInfo[2]; // 画像タイプを表す整数値を取得
29
30    echo "ファイル '{$filePath}' の画像タイプ数値は: {$imageType}\n";
31
32    // IMAGETYPE_AVIF 定数と比較して、画像がAVIF形式であるかを判定します。
33    // この定数はPHP 8.1以降で利用可能です。
34    if ($imageType === IMAGETYPE_AVIF) {
35        echo "この画像はAVIF形式です。\n";
36    } else {
37        echo "この画像はAVIF形式ではありません。\n";
38    }
39}
40
41// 単体で動作可能なコードとするため、使用例を含めます。
42// 以下のパスを、存在するAVIF画像ファイルへのパスに置き換えて実行してください。
43// AVIFファイルがない場合は、エラーメッセージが表示されます。
44
45// 例1: 存在しないファイルパスを渡した場合（エラーメッセージが出力されます）
46checkImageAvifType('non_existent_image.avif');
47echo "\n";
48
49// 例2: 存在するAVIFファイルを想定したパス（ファイルを用意して試してください）
50// このコードを実際に試す場合、`example.avif`というAVIFファイルを
51// スクリプトと同じディレクトリに置くか、適切なパスに書き換えてください。
52checkImageAvifType('example.avif');
53
54?>

このPHPサンプルコードは、指定された画像ファイルが「AVIF」という特定の画像形式であるかを判定する方法を、初心者の方にも分かりやすく示しています。

メインとなるcheckImageAvifType関数は、引数として画像ファイルのパス（$filePath）を受け取ります。この関数自体は具体的な処理結果を返さず（void）、判定結果を直接画面に出力します。

処理の内部では、PHPの組み込み関数であるgetimagesize()を利用して、画像ファイルの詳細な情報を取得しています。getimagesize()は、画像の幅や高さ、そして画像の種類などを配列として返しますが、特に配列のインデックス2には、画像の形式を示す整数値が格納されています。

この取得した整数値と、IMAGETYPE_AVIFという定数を比較することで、画像がAVIF形式であるかを判別します。IMAGETYPE_AVIF定数は、AVIF画像フォーマットを一意に識別するための数値で、PHP 8.1以降で導入されました。

もしファイルが存在しない、または有効な画像ファイルではない場合は、その旨のエラーメッセージが表示されます。正しく画像情報が取得できた場合は、その画像のタイプ数値と、AVIF形式であるかどうかの判定結果が画面に表示されます。実際にこのコードを試す際は、存在するAVIF画像ファイルへの正しいパスを指定して実行してください。

Copy
1<?php
2
3/**
4 * 画像ファイルのタイプを識別する定数の使用例を示します。
5 *
6 * IMAGETYPE_AVIF や IMAGETYPE_JPEG といった定数は、
7 * 画像ファイルの形式を表す整数値です。
8 * 通常、これらの定数は getimagesize() や exif_imagetype() 関数が返す値と比較され、
9 * 画像の種類を判別するために使用されます。
10 *
11 * @param string $filename 識別をシミュレートする画像ファイル名 (例: "image.avif")
12 * @return void
13 */
14function identifyImageTypeExample(string $filename): void
15{
16    echo "--- IMAGETYPE 定数の値 ---" . PHP_EOL;
17    // IMAGETYPE_AVIF は PHP 8.1 以降で利用可能です。
18    echo "IMAGETYPE_AVIF の値: " . IMAGETYPE_AVIF . PHP_EOL;
19    echo "IMAGETYPE_JPEG の値: " . IMAGETYPE_JPEG . PHP_EOL;
20    echo "IMAGETYPE_PNG の値: " . IMAGETYPE_PNG . PHP_EOL;
21    echo PHP_EOL;
22
23    echo "--- 画像タイプ判定のシミュレーション ---" . PHP_EOL;
24
25    // 実際のファイル操作なしで、これらの定数の利用方法を示すため、
26    // exif_imagetype() 関数が返す値をファイル名から仮定してシミュレートします。
27    // 実際には、exif_imagetype('path/to/actual_image.jpg') のように使用します。
28
29    $simulatedImageType = null;
30
31    // ファイル名の拡張子に基づいて、仮の画像タイプを設定します。
32    if (str_ends_with($filename, '.avif')) {
33        $simulatedImageType = IMAGETYPE_AVIF;
34        echo "ファイル '{$filename}' は AVIF ファイルとしてシミュレートされました。" . PHP_EOL;
35    } elseif (str_ends_with($filename, '.jpeg') || str_ends_with($filename, '.jpg')) {
36        $simulatedImageType = IMAGETYPE_JPEG;
37        echo "ファイル '{$filename}' は JPEG ファイルとしてシミュレートされました。" . PHP_EOL;
38    } elseif (str_ends_with($filename, '.png')) {
39        $simulatedImageType = IMAGETYPE_PNG;
40        echo "ファイル '{$filename}' は PNG ファイルとしてシミュレートされました。" . PHP_EOL;
41    } else {
42        echo "ファイル '{$filename}' のタイプは不明です（シミュレーション対象外）。" . PHP_EOL;
43        return; // シミュレーション対象外の場合は終了
44    }
45
46    // 取得した画像タイプがどの定数と一致するかをチェックします。
47    if ($simulatedImageType === IMAGETYPE_AVIF) {
48        echo "判定結果: これは AVIF 画像です。" . PHP_EOL;
49    } elseif ($simulatedImageType === IMAGETYPE_JPEG) {
50        echo "判定結果: これは JPEG 画像です。" . PHP_EOL;
51    } elseif ($simulatedImageType === IMAGETYPE_PNG) {
52        echo "判定結果: これは PNG 画像です。" . PHP_EOL;
53    } else {
54        // 将来の新しい画像タイプや未知のタイプの場合
55        echo "判定結果: その他の画像タイプです。（タイプ値: {$simulatedImageType}）" . PHP_EOL;
56    }
57}
58
59// -----------------------------------------------------
60// 関数の実行例
61// -----------------------------------------------------
62
63// AVIF ファイルタイプのシミュレーション
64identifyImageTypeExample('example_image.avif');
65echo PHP_EOL;
66
67// JPEG ファイルタイプのシミュレーション
68identifyImageTypeExample('photo.jpeg');
69echo PHP_EOL;
70
71// PNG ファイルタイプのシミュレーション
72identifyImageTypeExample('logo.png');
73echo PHP_EOL;
74
75// シミュレーション対象外のファイルタイプの例
76identifyImageTypeExample('document.txt');
77

PHPのIMAGETYPE_AVIF定数は、AVIF形式の画像ファイルを表す整数値です。これに加えて、IMAGETYPE_JPEGやIMAGETYPE_PNGといった定数も存在し、それぞれJPEGやPNGといった特定の画像形式を識別するために使用されます。これらの定数は、画像ファイルの実際のタイプを判別する際に、getimagesize()やexif_imagetype()といった関数が返す数値と比較して利用されます。

サンプルコードでは、まずIMAGETYPE_AVIF、IMAGETYPE_JPEG、IMAGETYPE_PNGといった定数自体が持つ整数値を出力しています。これにより、これらの定数が具体的な数値を表していることがわかります。

次に、identifyImageTypeExample関数を通じて、画像タイプを判定する処理のシミュレーションを行っています。この関数は$filenameという文字列の引数を受け取り、これは識別対象の画像ファイル名を想定しています。関数内部では、ファイル名の拡張子（例: .avifや.jpeg）に基づいて仮の画像タイプを設定し、それを各IMAGETYPE_XXX定数と比較することで、どの画像形式であるかを判定し、結果を画面に出力しています。この関数の戻り値はvoidであり、計算結果を返すのではなく、直接処理結果を表示する役割を担っています。この例は、実際のプログラムでexif_imagetype()関数などが返す値と定数を比較し、画像の形式を識別する基本的な流れを学ぶ上で役立ちます。