md5_file

関数の概要

PHPの md5_file 関数は、指定したファイルの内容を読み取り、そのMD5ハッシュ値を取得します。MD5はファイルのデータ整合性を確認したり、一意の識別子を生成する際に利用されるハッシュアルゴリズムの一つです。この関数を使うことで、簡単にファイルのチェックサムを取得できます。

パラメータの説明

  • filename（文字列）: MD5ハッシュを取得したい対象ファイルのパスを指定します。
  • raw_output（省略可能、ブール値）: trueを指定するとバイナリ形式でハッシュを返し、false（デフォルト）は16進数の文字列形式で返します。

戻り値

ファイルのMD5ハッシュ値を文字列として返します。raw_outputにtrueを指定した場合は、16バイトのバイナリデータとなります。ファイルが存在しない場合や読み込みに失敗した場合は false を返します。

使用例

基本的な使い方

<?php
$hash = md5_file('example.txt');
echo 'MD5ハッシュ: ' . $hash;
?>

example.txtというファイルのMD5ハッシュを16進数の文字列で取得し、画面に表示しています。

バイナリ形式での取得

<?php
$hashBinary = md5_file('example.txt', true);
echo 'バイナリ形式のMD5ハッシュ: ' . bin2hex($hashBinary);
?>

raw_outputにtrueを指定してバイナリ形式でハッシュを取得し、bin2hexで16進数に変換して表示しています。

ファイルの存在チェックと併用する例

<?php
$filename = 'example.txt';

if (file_exists($filename)) {
    $hash = md5_file($filename);
    echo "ファイル '{$filename}' のMD5ハッシュは: {$hash}";
} else {
    echo "ファイルが存在しません。";
}
?>

ファイルが存在するかを確認してからMD5ハッシュを取得することで、安全に処理を進める例です。

関連する関数

  • md5(): 文字列のMD5ハッシュを取得する関数
  • sha1_file(): ファイルのSHA-1ハッシュを取得する関数
  • hash_file(): より多くのハッシュアルゴリズムを指定してファイルのハッシュを取得可能

まとめ

md5_file関数はファイルのMD5ハッシュを簡単に取得できる便利な関数です。ファイルの内容検証や識別子の生成に役立ちます。ファイルの存在を確認し、場合によってはraw_outputパラメータを活用することで、柔軟なハッシュ値の取得が可能です。実務でも多用されるので、覚えておくと便利な関数です。

スポンサーリンク