【PHP8.x】md5_file関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルのMD5ハッシュ値を計算して表示するサンプルコード
7 *
8 * このスクリプトは、一時的なテキストファイルを作成し、
9 * そのファイルのMD5ハッシュ値を計算・表示してから、
10 * ファイルを削除するまでの一連の流れを示します。
11 */
12
13// ハッシュ値を計算する対象のファイル名
14$filename = 'sample_for_md5.txt';
15
16// ファイルに書き込む内容
17$content = 'This is a sample file to calculate the MD5 hash.';
18
19// 1. サンプルファイルを作成
20// file_put_contentsは、ファイルへのデータ書き込みを簡単に行うための関数です。
21if (file_put_contents($filename, $content) === false) {
22    echo "Error: Failed to create the sample file '{$filename}'." . PHP_EOL;
23    exit(1); // ファイル作成に失敗した場合は処理を中断
24}
25echo "File created: '{$filename}'" . PHP_EOL;
26
27
28// 2. ファイルのMD5ハッシュ値を計算
29// md5_file() は、指定されたファイルのMD5ハッシュを計算します。
30// ファイルが存在しない、または読み込めない場合は false を返します。
31$hash = md5_file($filename);
32
33
34// 3. 結果を出力
35if ($hash !== false) {
36    // 成功した場合、計算された32文字の16進数ハッシュ値を出力します。
37    echo "MD5 hash of the file: {$hash}" . PHP_EOL;
38} else {
39    // 失敗した場合、エラーメッセージを出力します。
40    echo "Error: Failed to calculate the MD5 hash of '{$filename}'." . PHP_EOL;
41}
42
43
44// 4. 後片付けとして作成したファイルを削除
45// unlink() は、ファイルを削除する関数です。
46if (unlink($filename)) {
47    echo "File deleted: '{$filename}'" . PHP_EOL;
48} else {
49    echo "Error: Failed to delete the sample file '{$filename}'." . PHP_EOL;
50}
51
52?>

PHPのmd5_file関数は、指定されたファイルのMD5ハッシュ値を計算するために利用されます。MD5ハッシュ値は、ファイルの内容に基づいて生成される一意の32文字の16進数文字列で、ファイルの同一性を確認する際などに役立ちます。

このサンプルコードでは、まず一時的なテキストファイルを作成し、そのファイルに対してmd5_file関数を使ってハッシュ値を計算しています。md5_file関数の最初の引数$filenameには、ハッシュ値を計算したいファイルのパスを文字列で渡します。例えば、md5_file('sample_for_md5.txt')のように指定します。2番目の引数$binaryはオプションで、デフォルトではfalseが設定されており、ハッシュ値を人間が読みやすい16進数文字列として返します。もしtrueに設定すると、MD5ハッシュの生バイナリ形式を返します。

関数は、ファイルの読み込みとハッシュ値の計算に成功した場合、計算されたMD5ハッシュ値を文字列として返します。しかし、指定されたファイルが存在しない、または読み込み権限がないなどの理由で処理が失敗した場合は、戻り値としてブール値のfalseを返します。サンプルコードでは、この戻り値を確認し、ハッシュ値が正常に取得できた場合はその値を表示し、失敗した場合はエラーメッセージを出力することで、安全な処理フローを示しています。最後に、作成した一時ファイルを削除する後片付けの処理も含まれています。