【PHP8.x】register_shutdown_function関数の使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * スクリプトの終了を管理するクラス
7 * 
8 * このクラスのインスタンスメソッドをシャットダウン関数として登録する例です。
9 */
10class ShutdownManager
11{
12    /**
13     * @var string 処理を実行したユーザー名
14     */
15    private string $user;
16
17    /**
18     * コンストラクタ
19     *
20     * @param string $user 処理を実行したユーザー名
21     */
22    public function __construct(string $user)
23    {
24        $this->user = $user;
25        echo "ShutdownManagerがユーザー '{$this->user}' で初期化されました。" . PHP_EOL;
26    }
27
28    /**
29     * スクリプト終了時に呼び出されるメソッド (シャットダウンハンドラ)
30     *
31     * このメソッドは public である必要があります。
32     * @param string $exitMessage 終了メッセージ
33     */
34    public function handleShutdown(string $exitMessage): void
35    {
36        // 実際のアプリケーションでは、ここでリソースの解放やログの記録などを行います。
37        $timestamp = date('Y-m-d H:i:s');
38        echo PHP_EOL . "--- シャットダウン処理開始 ---" . PHP_EOL;
39        echo "時刻: {$timestamp}" . PHP_EOL;
40        echo "ユーザー: {$this->user}" . PHP_EOL;
41        echo "終了メッセージ: {$exitMessage}" . PHP_EOL;
42        echo "--- シャットダウン処理終了 ---" . PHP_EOL;
43    }
44}
45
46// 1. クラスのインスタンスを生成します。
47//    コンストラクタで初期化された状態（ここでは $user）は、インスタンス内で保持されます。
48$manager = new ShutdownManager('admin');
49
50// 2. register_shutdown_function() を使って、インスタンスのメソッドを登録します。
51//    第一引数に [インスタンス, 'メソッド名'] の形式で指定します。
52//    第二引数以降は、登録したメソッドに渡される引数です。
53register_shutdown_function([$manager, 'handleShutdown'], '処理が正常に完了しました。');
54
55echo "メインの処理を実行しています..." . PHP_EOL;
56echo "メインの処理が完了しました。" . PHP_EOL;
57
58// このスクリプトが終了すると、登録された $manager->handleShutdown() が自動的に呼び出されます。
59// その際、コンストラクタで設定したプロパティ（$user）も利用できます。
60

このサンプルコードは、PHPのregister_shutdown_function関数を使い、クラスのインスタンスメソッドをスクリプト終了時に実行する方法を示しています。この関数は、スクリプトの実行が正常に終了した場合や、エラーで中断した場合など、処理が終了する際に必ず呼び出される関数を「予約」する機能を持っています。この関数自体は何も値を返しません（戻り値はvoidです）。

コードでは、まずShutdownManagerクラスのインスタンスを$managerという変数に作成しています。コンストラクタで渡されたユーザー名'admin'は、このインスタンスの内部に保存されます。 次にregister_shutdown_functionを呼び出しています。第一引数には、終了時に呼び出すコールバック関数を指定します。インスタンスメソッドを渡す場合は、[$manager, 'handleShutdown']のように、インスタンス変数とメソッド名を配列で指定します。第二引数以降は、そのメソッドに渡す引数を指定します。この例では、'処理が正常に完了しました。'という文字列がhandleShutdownメソッドの引数として渡されます。 メインの処理がすべて完了し、スクリプトが終了する直前のタイミングで、登録された$managerのhandleShutdownメソッドが自動的に実行されます。このとき、インスタンスが保持しているプロパティ（$user）も利用できるため、状態を維持したままリソースの解放やログ出力といった終了処理を安全に行うことができます。

Copy
1<?php
2
3/**
4 * スクリプトの実行終了時に呼び出される関数を登録します。
5 * この関数は、スクリプトの正常終了時だけでなく、致命的なエラーが発生した場合にも実行されます。
6 */
7register_shutdown_function(function () {
8    /**
9     * スクリプトの最後に発生したエラー情報を取得します。
10     * 致命的なエラー(E_ERRORなど)が発生した場合、その情報が含まれます。
11     * エラーが発生していない場合はnullを返します。
12     */
13    $error = error_get_last();
14
15    // エラー情報が存在するかどうかをチェックします
16    if ($error !== null) {
17        // エラーが存在する場合、その詳細を出力します。
18        // 実際のアプリケーションでは、これをログファイルに書き込んだり、監視システムに通知したりします。
19        echo "--- スクリプト終了時にエラーを検出しました ---\n";
20        echo "エラータイプ: " . ($error['type'] ?? '不明') . "\n";
21        echo "メッセージ: " . ($error['message'] ?? '不明') . "\n";
22        echo "ファイル: " . ($error['file'] ?? '不明') . "\n";
23        echo "行番号: " . ($error['line'] ?? '不明') . "\n";
24        echo "------------------------------------------------\n";
25    } else {
26        // エラーが存在しない場合、スクリプトが正常に終了したことを示します。
27        echo "--- スクリプトは正常に終了しました ---\n";
28    }
29});
30
31echo "スクリプトを開始しました。\n";
32
33// 以下は、エラー発生時の挙動を確認するためのコード例です。
34// それぞれの行のコメントアウトを外して実行し、動作の違いを確認してください。
35
36// E_NOTICE (通知) エラーの例: 未定義の変数を使用
37// echo $undefinedVariable;
38
39// E_WARNING (警告) エラーの例: 存在しないファイルを読み込もうとする
40// file_get_contents('non_existent_file.txt');
41
42// E_ERROR (致命的なエラー) の例: 存在しない関数を呼び出す
43// call_non_existent_function();
44
45// E_ERROR が発生した場合、この行は実行されずにシャットダウン関数が呼び出されます。
46// E_NOTICE や E_WARNING の場合は、この行も実行されます。
47echo "スクリプトの主要な処理が実行されています。\n";
48
49// ... 何らかの処理 ...
50
51echo "スクリプトが間もなく終了します。\n";
52
53// スクリプトの実行がここで終了し、登録されたシャットダウン関数が呼び出されます。
54

このPHPコードは、スクリプトの実行が終了する際に自動的に呼び出される関数を登録する方法を示しています。register_shutdown_function関数を使用することで、スクリプトが正常に完了した場合でも、致命的なエラー（E_ERRORなど）によって途中で中断された場合でも、引数に指定された処理（ここでは無名関数）が必ず実行されます。この関数の戻り値はvoidです。

登録されたシャットダウン関数の中では、error_get_last関数を使って、スクリプトの最後に発生したエラー情報を取得しています。この関数は、エラーが発生していなければnullを返し、致命的なエラーを含む何らかのエラーがあれば、その種類、メッセージ、ファイル、行番号などの詳細情報を含む配列を返します。これにより、予期せぬスクリプトの停止時に、その原因を特定する手助けとなります。

サンプルコードでは、取得したエラー情報が存在するかどうかをチェックし、エラーがあればその詳細を出力し、エラーがなければスクリプトが正常に終了したことを示します。コメントアウトされた部分を有効にすることで、通知（E_NOTICE）や警告（E_WARNING）、そして致命的なエラー（E_ERROR）が発生した場合に、シャットダウン関数がどのように機能し、エラーを捕捉するのかを確認できます。これは、スクリプトの安定性を高め、エラー発生時の適切な後処理を行う上で非常に重要な機能です。

Copy
1<?php
2
3/**
4 * スクリプトのシャットダウン時に実行される関数を定義します。
5 * Fatal Error (致命的なエラー) が発生した場合でもこの関数は実行されます。
6 */
7function handleShutdown(): void
8{
9    echo "--- スクリプトシャットダウン処理開始 ---\n";
10
11    // error_get_last() は、最後に発生したエラーの情報を配列で返します。
12    // エラーがなければ null を返します。
13    $lastError = error_get_last();
14
15    // エラーが存在し、そのエラータイプが致命的なエラー (E_ERROR) であるか確認します。
16    if ($lastError !== null && $lastError['type'] === E_ERROR) {
17        echo "致命的なエラー (Fatal Error) が検出されました！\n";
18        echo "エラーメッセージ: {$lastError['message']}\n";
19        echo "ファイル: {$lastError['file']}\n";
20        echo "行: {$lastError['line']}\n";
21        // ここで、エラー情報をログファイルに書き込んだり、
22        // 開いていたリソースを安全に閉じたりする処理を行うことができます。
23        echo "-> このエラー情報をログに記録し、必要なクリーンアップを行います。\n";
24    } else {
25        echo "スクリプトは正常に終了したか、致命的ではないエラーで終了しました。\n";
26    }
27
28    echo "--- スクリプトシャットダウン処理終了 ---\n";
29}
30
31// スクリプトの実行が終了する際に `handleShutdown` 関数が自動的に呼び出されるように登録します。
32register_shutdown_function('handleShutdown');
33
34echo "スクリプト開始。\n";
35echo "Fatal Error を意図的に発生させます...\n";
36
37// 存在しない関数を呼び出すことで、PHPは致命的なエラー (Fatal Error) を発生させ、
38// スクリプトの実行を中断します。
39// しかし、`register_shutdown_function` で登録された関数は、
40// その後でも実行されることが期待されます。
41nonExistentFunctionCall(); // この行で Fatal Error が発生します。
42
43echo "この行はFatal Errorのため、通常は実行されません。\n";
44
45?>

PHPのregister_shutdown_functionは、スクリプトの実行が終了する際に、指定した関数を自動的に呼び出す機能です。引数$callbackには実行したい関数を指定し、その関数に追加で渡したい引数がある場合は...$argsで指定します。この関数自体は何も値を返しません（void）。

この機能の特に重要な点は、スクリプトが正常に終了した場合だけでなく、致命的なエラー（Fatal Error）によって強制終了された場合でも、登録された関数が必ず実行されることです。

サンプルコードでは、handleShutdown関数をシャットダウン時に実行するよう登録しています。nonExistentFunctionCall()という存在しない関数を呼び出すことで、意図的に致命的なエラーを発生させていますが、スクリプトがこのエラーで中断された後でも、handleShutdown関数は確実に呼び出されます。

handleShutdown関数内ではerror_get_last()関数を使用して、最後に発生したエラー情報を取得しています。これにより、致命的なエラーが発生したことを検出し、そのエラーメッセージや発生箇所などの詳細情報を確認できます。この情報を利用して、エラーログへの記録、開いていたファイルやデータベース接続などのリソースを安全に閉じるクリーンアップ処理を行うことができます。

register_shutdown_functionを利用することで、PHPスクリプトが予期せぬ終了をした場合でも、システムの安定性を保ち、必要な後処理を確実に行うための堅牢なシステムを構築できます。