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

Copy
1<?php
2
3/**
4 * カスタムセッションハンドラを定義するクラスです。
5 * PHPの標準セッションハンドラ (SessionHandler) を継承することで、
6 * デフォルトのセッション管理機能を活用しつつ、特定の処理をオーバーライドできます。
7 * ここでは 'close' メソッドをオーバーライドして、セッション終了時の処理をカスタマイズします。
8 */
9class MyCustomSessionHandler extends SessionHandler
10{
11    /**
12     * セッションを閉じる際に自動的に呼び出されるメソッドです。
13     * セッションデータの書き込みが完了した後、またはスクリプトが終了する際に実行されます。
14     *
15     * @return bool セッションのクローズ処理が成功した場合は true、失敗した場合は false を返します。
16     */
17    public function close(): bool
18    {
19        // ここに、セッション終了時に実行したいカスタムロジックを記述します。
20        // 例: データベース接続のクリーンアップ、リソースの解放、特定のログ記録など。
21        // error_log() は、通常Webサーバーのエラーログファイル (例: Apacheのerror.log, Nginxのerror.log)
22        // またはphp.iniで指定された error_log ファイルに出力されます。
23        error_log("MyCustomSessionHandler::close() が呼び出されました。セッションを閉じます。");
24
25        // 通常、カスタムハンドラでは独自のクローズ処理を完結させ、
26        // 成功を示すために true を返します。
27        // 親クラスの close() メソッドを呼び出すことも可能ですが、
28        // ここでは明示的に true を返してシンプルな例を示します。
29        return true;
30    }
31
32    // 他のセッションハンドラメソッド (open, read, write, destroy, gc) は、
33    // このクラスが SessionHandler を継承しているため、デフォルトの実装が自動的に使用されます。
34    // 必要に応じて、これらのメソッドもオーバーライドしてカスタマイズできます。
35}
36
37// ----------------------------------------------------------------------
38// サンプルコードの実行部分
39// ----------------------------------------------------------------------
40
41// 1. カスタムセッションハンドラのインスタンスを作成します。
42$customHandler = new MyCustomSessionHandler();
43
44// 2. PHPにこのカスタムハンドラを使用するように登録します。
45//    第2引数に true を指定することで、既存のデフォルトハンドラをこのカスタムハンドラで
46//    置き換えるように指示します。(SessionHandler を継承している場合、この引数は内部的に処理されます)
47session_set_save_handler($customHandler, true);
48
49// 3. セッションを開始します。
50//    これにより、セッションデータが読み込まれ、カスタムハンドラの 'open' および 'read' メソッドが
51//    呼び出される可能性があります。
52session_start();
53
54// 4. セッション変数にデータを設定します。
55$_SESSION['username'] = 'beginner_user';
56$_SESSION['last_activity'] = date('Y-m-d H:i:s');
57
58echo "ブラウザに表示される出力:<br>";
59echo "セッション開始。ユーザー名: " . ($_SESSION['username'] ?? '未設定') . "<br>";
60echo "最終活動日時: " . ($_SESSION['last_activity'] ?? '未設定') . "<br>";
61echo "現在のセッションID: " . session_id() . "<br>";
62echo "<br>カスタムハンドラの close() メソッドが実行されたかどうかは、Webサーバーのエラーログを確認してください。<br>";
63echo "(例: Apacheのerror.log, Nginxのerror.log, またはphp.iniで指定された error_log ファイル)<br>";
64
65// 5. セッションを明示的に終了し、データを保存します。
66//    この関数を呼び出すことで、カスタムハンドラの 'write()' メソッドが呼び出され、
67//    続いて 'close()' メソッドが自動的に呼び出されます。
68//    この行がない場合でも、スクリプトの実行が終了する際に 'close()' メソッドは自動的に呼び出されます。
69session_write_close();
70
71echo "<br>session_write_close() が呼び出されました。これにより、セッションの保存とクローズ処理が完了しました。<br>";
72
73// この行以降はセッションが閉じられているため、$_SESSION は利用できません。
74// 例: session_start() を再度呼び出さない限り、$_SESSION の内容は空になります。
75
76?>

PHPのSessionHandler::closeメソッドは、セッションデータがディスクなどに保存された後や、PHPスクリプトの実行終了時に自動で呼び出される、セッション終了時の処理を受け持つメソッドです。このメソッドは、セッション管理のために開かれたファイルやデータベース接続などのリソースを確実に解放し、最終的なクリーンアップ処理を行うために利用されます。

このメソッドは引数を持ちません。戻り値はbool型で、処理が成功した場合はtrue、失敗した場合はfalseを返します。PHPはこの戻り値によって、セッションの終了処理が正常に完了したかを判断します。

サンプルコードでは、MyCustomSessionHandlerクラスが標準のSessionHandlerを継承し、closeメソッドを独自にオーバーライドしています。ここでは、セッション終了時に「セッションを閉じます」というメッセージをWebサーバーのエラーログに出力するカスタム処理を追加しています。session_set_save_handler()でこのカスタムハンドラを登録すると、session_write_close()が呼び出されるか、またはスクリプトの実行が終了した際に、オーバーライドされたcloseメソッドが自動的に実行されます。これにより、セッション終了時に必要なログ記録やリソース解放などのアプリケーション固有の処理を柔軟に組み込めるようになります。

Copy
1<?php
2
3/**
4 * カスタムセッションハンドラクラスの定義
5 * SessionHandlerを継承することで、PHPの標準セッション処理のほとんどを再利用しつつ、
6 * 特定のライフサイクルメソッド（今回はclose）の動作をカスタマイズできます。
7 * システムエンジニアを目指す初心者の方へ：
8 * このクラスは、PHPがセッションデータをどのように保存・管理するかを
9 * 自分で制御したい場合に作成します。例えば、セッションをファイルではなく
10 * データベースに保存したい、などの特殊な要件がある場合に使います。
11 */
12class MySessionHandler extends SessionHandler
13{
14    /**
15     * セッションを開く際にPHPによって呼び出されます。
16     * 通常、セッションストレージ（ファイル、データベースなど）への接続を確立します。
17     *
18     * @param string $path セッションファイルを保存するパス（通常、SessionHandlerの親メソッドに任せます）
19     * @param string $name セッション名（通常、SessionHandlerの親メソッドに任せます）
20     * @return bool 成功した場合に true、それ以外の場合に false を返します。
21     */
22    public function open(string $path, string $name): bool
23    {
24        // デモンストレーションのため、このメソッドが呼び出されたことをログに出力します。
25        // 実際のカスタムハンドラでは、ここでデータベース接続などの初期化処理を行います。
26        error_log("MySessionHandler::open が呼び出されました。");
27
28        // 親クラスのオープン処理を呼び出し、標準の動作を維持します。
29        return parent::open($path, $name);
30    }
31
32    /**
33     * セッションデータを読み込む際にPHPによって呼び出されます。
34     *
35     * @param string $id セッションID
36     * @return string セッションデータ (空の場合もあります)。読み込み失敗時は空文字列を返します。
37     */
38    public function read(string $id): string
39    {
40        error_log("MySessionHandler::read が呼び出されました。セッションID: " . $id);
41        // 親クラスの読み込み処理を呼び出し、標準の動作を維持します。
42        return parent::read($id);
43    }
44
45    /**
46     * セッションデータを書き込む際にPHPによって呼び出されます。
47     *
48     * @param string $id セッションID
49     * @param string $data セッションデータ
50     * @return bool 成功した場合に true、それ以外の場合に false を返します。
51     */
52    public function write(string $id, string $data): bool
53    {
54        error_log("MySessionHandler::write が呼び出されました。セッションID: " . $id . ", データ長: " . strlen($data));
55        // 親クラスの書き込み処理を呼び出し、標準の動作を維持します。
56        return parent::write($id, $data);
57    }
58
59    /**
60     * セッションを閉じる際にPHPによって呼び出されます。
61     * このメソッドは、セッションデータの書き込みが完了し、
62     * セッションに関連するリソース（例えばデータベース接続やファイルハンドル）を
63     * 解放する直前に呼び出されます。
64     *
65     * @return bool 成功した場合に true、それ以外の場合に false を返します。
66     */
67    public function close(): bool
68    {
69        // ここで、セッションのために開いたデータベース接続を閉じたり、
70        // ファイルハンドルを閉じたりするなど、リソースのクリーンアップを行います。
71        error_log("MySessionHandler::close が呼び出されました。セッションが正常に閉じられました。");
72
73        // 親クラスのクローズ処理を呼び出し、標準の動作を維持します。
74        // このメソッドは通常 true を返します。
75        return parent::close();
76    }
77
78    /**
79     * セッションを破棄する際にPHPによって呼び出されます。
80     *
81     * @param string $id セッションID
82     * @return bool 成功した場合に true、それ以外の場合に false を返します。
83     */
84    public function destroy(string $id): bool
85    {
86        error_log("MySessionHandler::destroy が呼び出されました。セッションID: " . $id);
87        // 親クラスの破棄処理を呼び出し、標準の動作を維持します。
88        return parent::destroy($id);
89    }
90
91    /**
92     * ガベージコレクション (GC) の際にPHPによって呼び出されます。
93     * 古いセッションデータを削除します。
94     *
95     * @param int $max_lifetime セッションの最大有効期間 (秒)
96     * @return bool 成功した場合に true、それ以外の場合に false を返します。
97     */
98    public function gc(int $max_lifetime): bool
99    {
100        error_log("MySessionHandler::gc が呼び出されました。最大有効期間: " . $max_lifetime . "秒");
101        // 親クラスのGC処理を呼び出し、標準の動作を維持します。
102        return parent::gc($max_lifetime);
103    }
104}
105
106// -----------------------------------------------------------------------------
107// サンプルコードの実行部分
108// -----------------------------------------------------------------------------
109
110// カスタムセッションハンドラのインスタンスを作成します。
111$handler = new MySessionHandler();
112
113// PHPに、標準のセッションハンドラの代わりに、作成したカスタムハンドラを
114// 使用するように設定します。第二引数を true にすると、登録後に古いハンドラを自動的に閉じます。
115session_set_save_handler($handler, true);
116
117// セッションを開始します。
118// これにより MySessionHandler::open と MySessionHandler::read が呼び出される可能性があります。
119session_start();
120echo "セッションが開始されました。<br>";
121error_log("session_start() が呼び出されました。");
122
123// セッション変数に値を設定または更新します。
124// これにより、セッション終了時（または session_write_close() 呼び出し時）に
125// MySessionHandler::write が呼び出されます。
126if (!isset($_SESSION['count'])) {
127    $_SESSION['count'] = 0;
128    echo "セッション変数 'count' を初期化しました。<br>";
129    error_log("セッション変数 'count' を初期化しました。");
130} else {
131    $_SESSION['count']++;
132    echo "セッション変数 'count' をインクリメントしました: " . $_SESSION['count'] . "<br>";
133    error_log("セッション変数 'count' をインクリメントしました: " . $_SESSION['count']);
134}
135
136// 現在のセッションIDとカウントをブラウザに表示します。
137echo "現在のセッションID: " . session_id() . "<br>";
138echo "現在のカウント: " . $_SESSION['count'] . "<br>";
139
140// セッションの書き込みとクローズを明示的に行います。
141// これにより、MySessionHandler::write（まだ書き込まれていなければ）と
142// MySessionHandler::close が確実に呼び出されます。
143// 通常はスクリプトの終了時にPHPによって自動的に呼び出されますが、
144// 明示的に呼び出すことで、セッション処理を早めに完了させることができます。
145session_write_close();
146echo "session_write_close() が呼び出されました。セッションが閉じられました。<br>";
147error_log("session_write_close() が呼び出されました。");
148
149// スクリプトの終了
150error_log("スクリプトが終了しました。");
151
152// このスクリプトを実行すると、Webサーバーのエラーログ（php-fpmログ、Apacheエラーログなど）に
153// MySessionHandlerの各メソッドがいつ呼び出されたかが出力されます。
154// ブラウザにはセッション情報と、処理の進捗が表示されます。
155?>

PHPのSessionHandler::closeメソッドは、セッションデータの書き込みが完了した後、またはセッション処理を終了する際にPHPによって自動的に呼び出されるライフサイクルメソッドです。このメソッドは、セッションのために開かれたリソース、例えばファイルハンドルやデータベース接続などを適切に解放し、クリーンアップする役割を担います。

このcloseメソッドは引数を一切取りません。戻り値はbool型で、セッションのクローズ処理が成功した場合はtrueを、何らかの理由で失敗した場合はfalseを返します。通常、セッションの終了処理は特別な問題がない限り成功するため、実装ではtrueを返すことが多いです。

サンプルコードでは、MySessionHandlerクラスでcloseメソッドを独自に実装し、このメソッドが呼び出されたことを示すログを出力しています。session_write_close()関数を明示的に呼び出すか、スクリプトの実行が終了する際に、このcloseメソッドが実行され、セッションに関連するリソースが解放されます。この仕組みを活用することで、PHPの標準的なセッション管理動作をカスタマイズし、例えばセッションデータをデータベースに保存するなどの独自の要件に対応できます。