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

Copy
1<?php
2
3/**
4 * MyCustomDateOperationException クラスは、DateInvalidOperationException を継承し、
5 * 日付関連の無効な操作に対して独自の例外メッセージを提供する例です。
6 *
7 * `getMessage` メソッドをオーバーライドすることで、デフォルトの例外メッセージに
8 * カスタムの情報を付加することができます。
9 */
10class MyCustomDateOperationException extends DateInvalidOperationException
11{
12    /**
13     * カスタム例外のコンストラクタです。
14     * 親クラスのコンストラクタを呼び出し、例外メッセージ、コード、前の例外を設定します。
15     *
16     * @param string $message 例外発生時に表示されるメッセージ
17     * @param int $code 例外を識別するためのコード
18     * @param Throwable|null $previous 連結された前の例外 (オプション)
19     */
20    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null)
21    {
22        parent::__construct($message, $code, $previous);
23    }
24
25    /**
26     * 親クラスの `getMessage` メソッドをオーバーライドします。
27     * ここでは、元のメッセージに「【カスタムエラー】: 」という接頭辞を追加しています。
28     *
29     * このように `getMessage` をオーバーライドすることは可能ですが、
30     * 通常はコンストラクタでメッセージを適切に設定し、このメソッドはそのまま使用されます。
31     * 特定の表示形式やログ形式に合わせたい場合に検討されることがあります。
32     *
33     * @return string カスタムされた例外メッセージ
34     */
35    public function getMessage(): string
36    {
37        return "【カスタムエラー】: " . parent::getMessage();
38    }
39}
40
41/**
42 * 無効な日付操作をシミュレートし、MyCustomDateOperationException をスローする関数です。
43 *
44 * この例では、`DateInvalidOperationException` が実際にスローされる状況（例: `DateTimeImmutable::modify()`
45 * に無効な引数を渡すなど）を再現するのではなく、カスタム例外の動作を示すため直接スローします。
46 *
47 * @param string $operationDescription 無効な操作の説明
48 * @throws MyCustomDateOperationException 無効な日付操作が発生した場合
49 */
50function performSimulatedInvalidDateOperation(string $operationDescription): void
51{
52    throw new MyCustomDateOperationException(
53        "日付操作 '" . $operationDescription . "' の実行中に問題が発生しました。"
54    );
55}
56
57// ----------------------------------------------------
58// サンプルコードの実行部分
59// ----------------------------------------------------
60
61try {
62    // カスタム例外をスローする処理を呼び出す
63    performSimulatedInvalidDateOperation("存在しない日付への変更");
64} catch (MyCustomDateOperationException $e) {
65    // MyCustomDateOperationException をキャッチし、オーバーライドされたgetMessage()を使用
66    echo "--- カスタム例外をキャッチしました ---" . PHP_EOL;
67    echo "メッセージ: " . $e->getMessage() . PHP_EOL; // オーバーライドされたメソッドが呼び出される
68    echo "ファイル: " . $e->getFile() . PHP_EOL;
69    echo "行番号: " . $e->getLine() . PHP_EOL;
70} catch (DateInvalidOperationException $e) {
71    // 親クラスの DateInvalidOperationException をキャッチ
72    // (この例では、MyCustomDateOperationException が先にキャッチされるため、ここには到達しません)
73    echo "--- DateInvalidOperationException をキャッチしました ---" . PHP_EOL;
74    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
75} catch (Throwable $e) {
76    // その他の全ての例外をキャッチ
77    echo "--- 予期せぬエラーが発生しました ---" . PHP_EOL;
78    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
79}
80

PHP 8におけるDateInvalidOperationExceptionクラスのgetMessageメソッドは、日付関連の無効な操作によって発生した例外のエラーメッセージを文字列として取得するために使用されます。このメソッドは引数を受け取らず、例外が内部に保持しているエラー内容を記述した文字列を返します。

提供されたサンプルコードでは、DateInvalidOperationExceptionを継承して独自のMyCustomDateOperationExceptionクラスを作成し、その中でgetMessageメソッドをオーバーライド（上書き）しています。これにより、親クラスから継承したデフォルトのエラーメッセージに、独自の情報を追加することが可能になります。具体的には、親クラスのgetMessageが返す元のメッセージの前に「【カスタムエラー】: 」という接頭辞を追加しています。

このカスタム例外は、performSimulatedInvalidDateOperation関数内で、日付操作に問題が発生したことを示すためにスローされます。try-catchブロックでこのカスタム例外を捕捉し、$e->getMessage()を呼び出すと、オーバーライドされたメソッドが実行され、接頭辞が付加されたカスタムメッセージが表示されます。通常、例外のメッセージはコンストラクタで設定することが一般的ですが、getMessageをオーバーライドすることで、特定の表示形式やログ形式に合わせてメッセージを加工するような場合にも利用できます。

Copy
1<?php
2
3/**
4 * PHP 8.2 以降で利用可能な DateInvalidOperationException::getMessage() のサンプルコード。
5 * エラーメッセージを短縮（truncated）して表示する例を示します。
6 */
7
8try {
9    // 日付操作に関連する無効な状態をシミュレートするために、
10    // DateInvalidOperationException を直接スローします。
11    // 実際のアプリケーションでは、無効な日付範囲や形式などによって
12    // この例外が自動的にスローされることがあります。
13    throw new DateInvalidOperationException("The specified date period is invalid. Start date must not be after end date, and the duration cannot exceed 5 years. Please review your date range parameters.");
14
15} catch (DateInvalidOperationException $e) {
16    // DateInvalidOperationException がキャッチされた場合、
17    // getMessage() メソッドを使用してエラーの詳細（文字列）を取得します。
18    $fullErrorMessage = $e->getMessage();
19
20    // エラーメッセージが長すぎる場合に備え、表示用に短縮（truncated）する処理を記述します。
21    // これはキーワード「truncated」への対応です。
22    $maxLengthForDisplay = 80; // 表示する最大文字数
23
24    // メッセージが最大長を超える場合、短縮します。
25    $truncatedErrorMessage = $fullErrorMessage;
26    if (mb_strlen($fullErrorMessage) > $maxLengthForDisplay) {
27        $truncatedErrorMessage = mb_substr($fullErrorMessage, 0, $maxLengthForDisplay) . '...';
28    }
29
30    echo "発生した日付操作エラー（短縮版）: " . $truncatedErrorMessage . PHP_EOL;
31    // 必要に応じて、完全なエラーメッセージも表示できます。
32    // echo "発生した日付操作エラー（完全版）: " . $fullErrorMessage . PHP_EOL;
33
34} catch (Exception $e) {
35    // DateInvalidOperationException 以外の予期せぬ例外をキャッチします。
36    echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
37}

PHP 8.2以降で導入されたDateInvalidOperationException::getMessage()メソッドは、日付操作に関連して発生した無効な状態の詳細なエラー情報を取得するために使用されます。このメソッドは引数を一切取らず、例外に含まれる具体的なエラーメッセージを文字列（string）として返します。

サンプルコードでは、tryブロック内で日付操作に関する無効なシナリオをシミュレートするため、DateInvalidOperationExceptionを意図的にスローしています。実際のアプリケーションでは、無効な日付範囲の指定や不適切な日付形式などが原因でこの例外が自動的に発生します。

catch (DateInvalidOperationException $e)ブロックでこの例外を捕捉した後、$e->getMessage()を呼び出すことで、発生したエラーの具体的な説明文を取得しています。取得したエラーメッセージは、その内容が長い場合に備えて、表示に適した長さに短縮（truncated）する処理が施されています。これは、ユーザーインターフェースなどで長いメッセージを簡潔に表示するための一般的な手法です。このようにエラーメッセージを適切に取得し、必要に応じて加工することは、問題の原因を特定し、ユーザーに分かりやすい情報を提供する上で非常に重要です。