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

Copy
1<?php
2
3/**
4 * 指定されたファイルのコンテンツを安全に取得します。
5 * ファイルが存在しないか、読み込みに失敗した場合にDateExceptionをスローします。
6 *
7 * @param string $filePath 読み込むファイルのパス
8 * @return string ファイルの内容
9 * @throws DateException ファイルの読み込みに失敗した場合。
10 *                      Note: DateExceptionは通常日付関連のエラーに使用されますが、
11 *                      ここではgetFile()メソッドの動作を示すための例として使用しています。
12 */
13function safeGetFileContent(string $filePath): string
14{
15    // ファイルが存在しない、または読み込み権限がない場合
16    if (!file_exists($filePath) || !is_readable($filePath)) {
17        // 例外をスロー。getFile()メソッドはこの例外がスローされたファイルパスを返します。
18        throw new DateException("ファイル '{$filePath}' が存在しないか、読み込み権限がありません。");
19    }
20
21    // file_get_contents()でファイルの内容を取得。
22    // エラー抑制演算子(@)を使用し、PHPの警告を抑制しつつ、戻り値でエラーをハンドリングします。
23    $content = @file_get_contents($filePath);
24
25    // ファイルの内容取得に失敗した場合
26    if ($content === false) {
27        throw new DateException("ファイル '{$filePath}' の内容取得に失敗しました。");
28    }
29
30    return $content;
31}
32
33// --- サンプル実行 ---
34
35// 存在しないファイルを指定してエラーを発生させる例
36$nonExistentFile = "non_existent_file_for_getFile_test.txt";
37
38try {
39    echo "{$nonExistentFile} の内容取得を試みます..." . PHP_EOL;
40    $content = safeGetFileContent($nonExistentFile);
41    echo "ファイル内容: " . $content . PHP_EOL;
42} catch (DateException $e) {
43    echo "--- エラー捕捉 ---" . PHP_EOL;
44    echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
45    // DateException::getFile() を呼び出し、例外がスローされたPHPスクリプトのファイルパスを取得します。
46    echo "エラー発生ファイル: " . $e->getFile() . PHP_EOL;
47    echo "エラー発生行: " . $e->getLine() . PHP_EOL;
48}
49
50?>

PHP 8のDateException::getFile()メソッドは、プログラムの実行中にエラーが発生し例外がスローされた際に、その例外がスローされたPHPスクリプトのファイルパスを取得するために使用されます。このメソッドは引数を一切取らず、例外が発生したファイルへの完全なパスを文字列（string）として返します。

提供されたサンプルコードでは、safeGetFileContent関数が指定されたファイルの読み込みに失敗した場合に、意図的にDateExceptionをスローする例を示しています。この例外がtry-catchブロックで捕捉されると、捕捉されたDateExceptionオブジェクト（$e）から$e->getFile()を呼び出すことで、エラーが発生したPHPスクリプトのファイルパスを簡単に取得できます。

DateExceptionは通常、日付や時刻関連の操作で問題が発生した場合に利用される例外クラスですが、この例ではgetFile()メソッドの挙動を説明するために使用されています。getFile()メソッドは、例外が発生した正確な場所を特定し、デバッグ作業を効率化する上で非常に役立つ情報を提供します。

Copy
1<?php
2
3/**
4 * 指定されたファイルのサイズをバイト単位で取得します。
5 * ファイルが存在しない場合や、サイズの取得に失敗した場合はエラーメッセージを出力し、nullを返します。
6 *
7 * @param string $filePath ファイルのパス
8 * @return int|null ファイルサイズ（バイト単位）、またはエラーの場合は null
9 */
10function getFileSizeInBytes(string $filePath): ?int
11{
12    // ファイルが存在するかどうかを確認します。
13    if (!file_exists($filePath)) {
14        echo "エラー: ファイル '{$filePath}' が存在しません。" . PHP_EOL;
15        return null;
16    }
17
18    // filesize() 関数を使用して、ファイルのサイズをバイト単位で取得します。
19    // 成功した場合はファイルサイズを整数で、失敗した場合は false を返します。
20    $size = filesize($filePath);
21
22    // filesize() が false を返した場合（エラーが発生した場合）の処理です。
23    if ($size === false) {
24        echo "エラー: ファイル '{$filePath}' のサイズを取得できませんでした。" . PHP_EOL;
25        return null;
26    }
27
28    // 取得したファイルサイズを返します。
29    return $size;
30}
31
32// --- サンプルコードの実行例 ---
33
34// 1. テスト用のファイルを一時的に作成します。
35$sampleFileName = 'example_file.txt';
36// ファイルに適当な内容を書き込み、サイズが0でないことを保証します。
37file_put_contents($sampleFileName, 'このファイルはテスト用に作成されました。');
38
39// 2. 作成したファイルのサイズを取得して表示します。
40$fileSize = getFileSizeInBytes($sampleFileName);
41
42if ($fileSize !== null) {
43    echo "ファイル '{$sampleFileName}' のサイズ: {$fileSize} バイト" . PHP_EOL;
44}
45
46// 3. 存在しないファイルのサイズを取得しようとする例です。
47$nonExistentFile = 'non_existent.txt';
48getFileSizeInBytes($nonExistentFile);
49
50// 4. テスト用に作成したファイルをクリーンアップ（削除）します。
51if (file_exists($sampleFileName)) {
52    unlink($sampleFileName);
53    echo "テストファイル '{$sampleFileName}' を削除しました。" . PHP_EOL;
54}
55
56?>

このPHPサンプルコードは、指定されたファイルのサイズをバイト単位で安全に取得する方法を示しています。getFileSizeInBytes という関数が定義されており、ファイルが存在しない場合や、サイズの取得に失敗した場合のエラー処理が組み込まれています。

この関数は、引数として string 型のファイルパス（$filePath）を受け取ります。これは、サイズを調べたいファイルの場所を示す文字列です。関数内部では、まず file_exists() 関数を使って、指定されたファイルが本当に存在するかを確認します。ファイルが見つからない場合は、エラーメッセージを表示し、戻り値として null を返します。

次に、ファイルの存在が確認できれば、PHP標準の filesize() 関数を用いてファイルのサイズをバイト単位で取得します。この filesize() 関数は、成功すると int 型のファイルサイズを返し、失敗すると false を返します。getFileSizeInBytes 関数は、filesize() が false を返した場合もエラーとして扱い、エラーメッセージを表示して null を返します。

最終的に、ファイルサイズが正常に取得できた場合のみ、その int 型のバイト数が関数の戻り値として返されます。このように、戻り値が int（サイズ）または null（エラー）となることで、呼び出し元は処理の結果を明確に判断でき、ファイル操作における堅牢性が向上します。