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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * ファイルの内容を読み込み、指定された最小長を満たしているか検証します。
7 *
8 * この関数は、ファイルの内容が短すぎる場合に LengthException をスローすることで、
9 * 呼び出し元で例外処理を試すためのサンプルです。
10 *
11 * @param string $filePath 検証するファイルへのパス
12 * @param int $minLength 許容されるコンテンツの最小文字数
13 * @return string ファイルのコンテンツ
14 * @throws LengthException ファイルの内容が $minLength より短い場合にスローされます
15 */
16function getFileContentWithValidation(string $filePath, int $minLength): string
17{
18    // 指定されたパスからファイルの内容を読み込む
19    $content = file_get_contents($filePath);
20    if ($content === false) {
21        // 読み込みに失敗した場合は空文字として扱う（エラー処理は簡略化）
22        $content = '';
23    }
24
25    // 読み込んだコンテンツの長さが、指定された最小長に満たないかチェック
26    if (mb_strlen($content) < $minLength) {
27        // 条件を満たさない場合、LengthExceptionをスローする
28        throw new LengthException("ファイルの内容が{$minLength}文字未満です。");
29    }
30
31    return $content;
32}
33
34// --- ここからが実行サンプルコードです ---
35
36// 一時的なテストファイルを作成
37$tempFile = 'sample.txt';
38file_put_contents($tempFile, 'Hello PHP'); // 9文字のコンテンツ
39
40try {
41    // わざと例外が発生する条件で関数を呼び出す (最小長を10文字に設定)
42    echo "ファイル '{$tempFile}' の内容を検証中 (最小10文字)...\n";
43    $content = getFileContentWithValidation($tempFile, 10);
44    echo "検証成功: " . $content . "\n";
45} catch (LengthException $e) {
46    // スローされたLengthExceptionを捕捉する
47    echo "検証エラー: " . $e->getMessage() . "\n";
48
49    // Exception::getFile() メソッドを使い、例外がスローされたファイル名を取得して表示する
50    // この場合、このPHPスクリプト自体のファイル名が表示されます
51    echo "エラーが発生したファイル: " . $e->getFile() . "\n";
52
53    // 補足: エラーが発生した行番号も取得できる
54    echo "エラーが発生した行番号: " . $e->getLine() . "\n";
55} finally {
56    // 実行後、作成した一時ファイルを削除する
57    if (file_exists($tempFile)) {
58        unlink($tempFile);
59    }
60}

LengthExceptionクラスのgetFileメソッドは、例外（プログラムの異常事態）がどのファイルで発生したかを知るために使用します。このメソッドは、PHPの基本的なExceptionクラスから継承されており、引数を必要としません。戻り値として、例外がスローされた（発生した）時点のファイル名を文字列（フルパス）で返します。

サンプルコードでは、まずgetFileContentWithValidationという関数を定義しています。この関数は、指定されたファイルの内容を読み込み、その文字数が設定された最小値より短い場合にLengthExceptionをスローします。

実行部分では、try...catchブロックを使ってこの関数を呼び出しています。サンプルでは意図的に文字数が足りない状況を作り出し、例外を発生させています。catchブロックでLengthExceptionが捕捉されると、その例外オブジェクト（変数$e）に対して$e->getFile()を実行します。これにより、throw new LengthException(...)というコードが実行されたファイル、つまりこのサンプルコード自身のファイル名が取得され、画面に表示されます。

このようにgetFileメソッドは、エラーの原因がどのファイルにあるのかを特定する際に役立ち、デバッグ作業を効率的に進めるための重要な手がかりとなります。

Copy
1<?php
2
3/**
4 * 指定されたファイルのコンテンツを読み込み、期待される長さと一致するか検証します。
5 * 長さが一致しない場合、LengthExceptionをスローします。
6 *
7 * @param string $filename 検証するファイル名
8 * @param int $expectedLength 期待されるコンテンツの長さ
9 * @return string ファイルのコンテンツ
10 * @throws LengthException コンテンツの長さが期待値と異なる場合にスローされる
11 */
12function readFileWithLengthCheck(string $filename, int $expectedLength): string
13{
14    // キーワード: file_get_contents() を使ってファイルの内容を読み込む
15    // @ をつけているのは、ファイルが存在しない場合などに発生するWarningを抑制し、
16    // 自前のエラーハンドリングで処理するためです。
17    $content = @file_get_contents($filename);
18
19    if ($content === false) {
20        // ファイルが読み込めなかった場合も、長さが期待と異なると見なして例外をスローする
21        throw new LengthException("ファイル '{$filename}' の読み込みに失敗しました。");
22    }
23
24    $actualLength = strlen($content);
25
26    if ($actualLength !== $expectedLength) {
27        // 読み込んだコンテンツの長さが期待値と異なる場合に例外をスローする
28        throw new LengthException(
29            "ファイル '{$filename}' のコンテンツ長 ({$actualLength}) が期待値 ({$expectedLength}) と異なります。"
30        );
31    }
32
33    return $content;
34}
35
36// --- サンプルコードの実行部分 ---
37
38// テスト用のファイル名と内容を定義
39$testFile = 'test.txt';
40$testContent = 'Hello PHP'; // 長さは9
41file_put_contents($testFile, $testContent);
42
43// try-catchブロックで例外処理を実装
44try {
45    // わざと期待する長さを間違えて関数を呼び出し、例外を発生させる
46    echo "ファイルの長さを検証します...\n";
47    $content = readFileWithLengthCheck($testFile, 10);
48    echo "検証成功: " . $content . "\n";
49} catch (LengthException $e) {
50    // LengthException が発生した場合に、このブロックが実行される
51    echo "エラーが発生しました。\n";
52    echo "メッセージ: " . $e->getMessage() . "\n";
53    
54    // リファレンス情報: getFile() メソッドで例外が発生したファイル名を取得
55    echo "ファイル: " . $e->getFile() . "\n";
56    echo "行番号: " . $e->getLine() . "\n";
57} finally {
58    // 正常終了・例外発生のどちらの場合でも、後片付けとしてテストファイルを削除する
59    if (file_exists($testFile)) {
60        unlink($testFile);
61        echo "テストファイルをクリーンアップしました。\n";
62    }
63}

このPHPサンプルコードは、ファイルの文字数が期待通りかを確認し、異なる場合にエラーを処理する例を示しています。

readFileWithLengthCheck関数は、file_get_contents() を使ってファイルの内容を文字列として読み込みます。そして、その文字数が期待された値と異なるとき、LengthExceptionという種類のエラー（例外）を意図的に発生させます。

プログラムの実行部分では、try-catch構文が使われています。tryブロックの中で、わざと間違った文字数を指定して関数を呼び出し、LengthExceptionを発生させます。エラーが起きると、プログラムはcatchブロックの処理に移ります。

catchブロックでは、捕らえた例外オブジェクト（変数$e）から詳細な情報を取得できます。$e->getMessage()でエラーメッセージ、$e->getLine()でエラーが発生した行番号が表示されます。ここで使われている$e->getFile()メソッドは、引数を必要とせず、例外が発生したPHPファイルのフルパスを文字列として返します。この情報により、どのファイルで問題が起きたのかを正確に特定でき、プログラムの修正（デバッグ）に役立ちます。このように、try-catchと例外オブジェクトのメソッドを組み合わせることで、エラー発生時に詳細な情報を得て、適切に対応することが可能になります。