【PHP8.x】DateMalformedIntervalStringException::codeプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5// このコードは PHP 8.3 以降で動作します。
6// CodeIgniter のコントローラ内でユーザー入力を処理する状況を想定したサンプルです。
7
8namespace App\Controllers;
9
10use DateInterval;
11use DateMalformedIntervalStringException;
12
13/**
14 * 日付間隔の処理をシミュレートするクラス
15 *
16 * このクラスは、不正な形式の日付間隔文字列が与えられた場合に
17 * DateMalformedIntervalStringException を捕捉し、
18 * その例外コードを取得する方法を示します。
19 */
20class IntervalProcessor
21{
22    /**
23     * 不正な日付間隔文字列を処理し、例外コードを取得します。
24     *
25     * @param string $intervalString ユーザーから入力された日付間隔文字列
26     * @return void
27     */
28    public function process(string $intervalString): void
29    {
30        echo "処理中の文字列: '{$intervalString}'\n";
31
32        try {
33            // 文字列から DateInterval オブジェクトを生成
34            // 不正な形式の場合、DateMalformedIntervalStringException がスローされる
35            $interval = DateInterval::createFromDateString($intervalString);
36
37            echo "パース成功: " . $interval->format('%y年 %mヶ月 %d日') . "\n";
38        } catch (DateMalformedIntervalStringException $e) {
39            // 例外を捕捉
40            echo "エラー: 不正な日付間隔文字列です。\n";
41            echo "メッセージ: " . $e->getMessage() . "\n";
42
43            // Exceptionクラスから継承された 'code' プロパティの値を取得します。
44            // DateMalformedIntervalStringException 自体は特定のコードをセットしないため、
45            // 明示的に指定されない限り、通常は 0 が返されます。
46            $exceptionCode = $e->getCode();
47            echo "例外コード: " . $exceptionCode . "\n";
48
49            // CodeIgniter環境では、ここでログ出力やエラーページへのリダイレクトなどを行う
50            // log_message('error', 'Invalid interval string: ' . $e->getMessage());
51        } finally {
52            echo "--------------------\n";
53        }
54    }
55}
56
57// --- 単体で動作させるための実行コード ---
58// CodeIgniterのルーティングの代わりに、直接クラスをインスタンス化してメソッドを呼び出します。
59$processor = new IntervalProcessor();
60
61// 成功する例
62$processor->process('+1 day');
63
64// DateMalformedIntervalStringException が発生する例
65$processor->process('invalid string');

このPHPサンプルコードは、DateMalformedIntervalStringExceptionクラスが持つcodeプロパティの役割を説明するものです。codeプロパティは、発生した例外に関するエラーコードを整数(int)で保持しており、Exceptionクラスから継承された機能です。

コードでは、日付や時刻の間隔を表す文字列をオブジェクトに変換するDateInterval::createFromDateString()関数を使用しています。'+1 day'のような正しい形式の文字列は正常に処理されますが、'invalid string'のような解釈不可能な文字列が渡されるとDateMalformedIntervalStringExceptionという例外が発生します。

try...catch構文を使ってこの例外を捕捉し、$e->getCode()を呼び出すことでcodeプロパティの値を取得できます。getCode()メソッドは引数を取らず、例外コードを整数で返します。DateMalformedIntervalStringExceptionの場合、特定のコードは設定されないため、このプロパティは通常、デフォルト値である0を返します。この仕組みにより、エラーの種類を数値で識別し、プログラムに応じた処理を実装することが可能になります。

Copy
1<?php
2
3/**
4 * DateMalformedIntervalStringException::code プロパティの使用例を示します。
5 *
6 * この例外は、不正な形式の DateInterval 文字列が渡された場合にスローされます。
7 * PHP_CodeSniffer はコーディング規約の遵守を促すツールであり、
8 * このような適切な例外処理の実装は、CodeSniffer が推奨する堅牢で読みやすいコードの一部です。
9 * ここでは、PHP の推奨コーディングスタイルに従っています。
10 */
11function demonstrateDateMalformedIntervalStringExceptionCode(): void
12{
13    echo "DateMalformedIntervalStringException::code プロパティの取得デモ:\n";
14
15    try {
16        // DateMalformedIntervalStringException を意図的に発生させます。
17        // DateInterval のコンストラクタに 'P' の後に期間指定がない不正な文字列を渡します。
18        //
19        // 注意: 公式ドキュメントではこの例外は PHP 8.2.0 以降で導入とされていますが、
20        // 提供されたリファレンス情報が「PHP 8」と指定しているため、
21        // その情報に基づいてこの例外が存在するものとしてコードを記述します。
22        new DateInterval('P');
23    } catch (DateMalformedIntervalStringException $e) {
24        echo "DateMalformedIntervalStringException を捕捉しました。\n";
25        echo "メッセージ: " . $e->getMessage() . "\n";
26        // 'code' プロパティは、例外に関連付けられた整数値を返します。
27        // 組み込みの例外の場合、明示的に設定されない限り通常は 0 です。
28        echo "例外コード (code): " . $e->code . " (型: " . gettype($e->code) . ")\n";
29
30        // PHP_CodeSniffer は、適切な例外処理ブロックの構造や、
31        // 変数の命名規約 (例: $e) などをチェックし、コードの品質向上を助けます。
32        // ここに示される例外の捕捉と情報へのアクセスは、堅牢なアプリケーションの基礎です。
33    } catch (Throwable $e) {
34        // DateMalformedIntervalStringException が存在しない PHP 8.0/8.1 環境では、
35        // 代わりに ValueError などの別の例外がスローされる可能性があります。
36        // このブロックは、その場合の汎用的な処理を示します。
37        echo "予期せぬ別の例外を捕捉しました: " . get_class($e) . "\n";
38        echo "メッセージ: " . $e->getMessage() . "\n";
39        echo "コード: " . $e->getCode() . "\n";
40    }
41
42    echo "\nデモが終了しました。\n";
43}
44
45// 関数を実行します。
46demonstrateDateMalformedIntervalStringExceptionCode();

このPHPサンプルコードは、DateMalformedIntervalStringExceptionクラスが持つcodeプロパティの使い方を解説するものです。

コードでは、tryブロック内でDateIntervalクラスのインスタンスを生成する際に、意図的に不正な形式の文字列'P'を渡しています。これは期間の指定が不完全なため、DateMalformedIntervalStringExceptionという例外が発生します。

続くcatchブロックで、発生した例外を$eという変数で捕捉します。この例外オブジェクトが持つcodeプロパティ（$e->code）にアクセスすると、例外に関連付けられたエラーコードを取得できます。このプロパティは引数を取らず、戻り値として整数(int)を返します。PHPの組み込み例外では、開発者が明示的に数値を設定しない限り、このコードは通常0となります。

PHP_CodeSnifferは、コーディング規約の遵守をチェックするツールです。このサンプルのようにtry...catch構文を用いて予期せぬエラーを適切に処理することは、PHP_CodeSnifferが推奨する堅牢で保守性の高いコード記述の基本となります。このコードは、例外から詳細な情報を取得し、適切に対応する方法を示しています。