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

Copy
1<?php
2
3/**
4 * MySessionHandlerクラスはSessionHandlerInterfaceを実装し、カスタムセッションハンドリングを提供します。
5 * この例では、ファイルシステムを使用してセッションデータを保存・管理します。
6 * SessionHandlerInterface::destroy() メソッドは、session_destroy() が呼び出された際にセッションデータを破棄するために使用されます。
7 */
8class MySessionHandler implements SessionHandlerInterface
9{
10    /**
11     * @var string セッションデータを保存するディレクトリのパス
12     */
13    private string $savePath;
14
15    /**
16     * コンストラクタでセッションデータの保存パスを設定します。
17     * 実際のアプリケーションでは、より永続的で安全なパスを指定することが推奨されます。
18     *
19     * @param string $savePath セッションデータを保存するディレクトリのパス。空の場合はシステムの一時ディレクトリを使用します。
20     */
21    public function __construct(string $savePath = '')
22    {
23        // デフォルトの保存パスとしてシステムの一時ディレクトリを使用するか、指定されたパスを使用します。
24        $this->savePath = $savePath ?: sys_get_temp_dir() . '/php_custom_sessions';
25
26        // 指定されたパスが存在しない場合は作成を試みます。
27        if (!is_dir($this->savePath)) {
28            // ディレクトリを作成します。パーミッションは必要に応じて調整してください。
29            mkdir($this->savePath, 0777, true);
30        }
31    }
32
33    /**
34     * セッションを開く際に呼び出されます。
35     *
36     * @param string $path セッションデータのパス (通常は無視されます)
37     * @param string $name セッション名 (通常は無視されます)
38     * @return bool 成功した場合はtrue、失敗した場合はfalse
39     */
40    public function open(string $path, string $name): bool
41    {
42        // このハンドラでは、openメソッドで特別な初期化処理は不要です。
43        // パスが書き込み可能であるかを確認するなどの処理を行うこともあります。
44        return true;
45    }
46
47    /**
48     * セッションデータを読み込みます。
49     *
50     * @param string $id セッションID
51     * @return string 読み込んだセッションデータ、またはデータがない場合は空文字列
52     */
53    public function read(string $id): string
54    {
55        $file = $this->savePath . '/sess_' . $id;
56        if (file_exists($file)) {
57            return (string)file_get_contents($file);
58        }
59        return '';
60    }
61
62    /**
63     * セッションデータを書き込みます。
64     *
65     * @param string $id セッションID
66     * @param string $data セッションデータ
67     * @return bool 成功した場合はtrue、失敗した場合はfalse
68     */
69    public function write(string $id, string $data): bool
70    {
71        $file = $this->savePath . '/sess_' . $id;
72        // ファイルにセッションデータを書き込みます。
73        return (bool)file_put_contents($file, $data);
74    }
75
76    /**
77     * セッションを閉じる際に呼び出されます。
78     *
79     * @return bool 成功した場合はtrue、失敗した場合はfalse
80     */
81    public function close(): bool
82    {
83        // このハンドラでは、closeメソッドで特別な終了処理は不要です。
84        return true;
85    }
86
87    /**
88     * セッションデータを破棄します。
89     * これは session_destroy() が呼び出された際に、指定されたセッションIDに対応するサーバー上のセッションデータを削除するために使用されます。
90     *
91     * @param string $id 破棄するセッションのID
92     * @return bool 成功した場合はtrue、失敗した場合はfalse
93     */
94    public function destroy(string $id): bool
95    {
96        $file = $this->savePath . '/sess_' . $id;
97        if (file_exists($file)) {
98            // セッションファイルを削除します。
99            return unlink($file);
100        }
101        // ファイルが存在しない場合も、セッションは破棄されたものとみなして成功を返します。
102        return true;
103    }
104
105    /**
106     * ガベージコレクション (GC) を実行します。
107     * 期限切れのセッションデータを削除するために呼び出されます。
108     *
109     * @param int $max_lifetime セッションの最大有効期限 (秒)
110     * @return bool 成功した場合はtrue、失敗した場合はfalse
111     */
112    public function gc(int $max_lifetime): bool
113    {
114        // セッション保存ディレクトリ内のすべてのセッションファイルに対して処理を行います。
115        foreach (glob($this->savePath . '/sess_*') as $file) {
116            // ファイルの最終更新時刻と最大有効期限を比較し、期限切れであれば削除します。
117            if (file_exists($file) && filemtime($file) + $max_lifetime < time()) {
118                unlink($file);
119            }
120        }
121        return true;
122    }
123}
124
125// --- 以下、カスタムセッションハンドラの使用例とセッション破棄処理 ---
126
127// カスタムセッションハンドラを初期化します。
128// コンストラクタで指定されたパスにセッションファイルが保存されます。
129$handler = new MySessionHandler();
130
131// カスタムセッションハンドラをPHPに登録します。
132// 第2引数に true を指定することで、session_set_save_handler() が登録後にセッションGCを設定します。
133session_set_save_handler($handler, true);
134
135// セッションを開始します。
136// これにより MySessionHandler::open() メソッドが呼び出され、その後 MySessionHandler::read() が呼び出され、セッションデータが読み込まれます。
137session_start();
138
139// 現在のセッションIDを表示します。
140echo "現在のセッションID: " . session_id() . "\n\n";
141
142// セッションが初めての場合、データを設定します。
143if (!isset($_SESSION['visits'])) {
144    $_SESSION['visits'] = 1;
145    echo "初めての訪問です。セッションに訪問回数を設定しました。\n";
146} else {
147    $_SESSION['visits']++;
148    echo "訪問回数: " . $_SESSION['visits'] . "回\n";
149}
150echo "セッションデータ（$_SESSION['visits']）が保存されました。\n\n";
151
152// この時点で、ブラウザにはセッションIDを含むクッキー（例: PHPSESSID）が発行されています。
153
154echo "--- セッション破棄処理を開始します ---\n";
155
156// セッションデータをサーバーから完全に破棄します。
157// この関数が呼び出されると、登録されているカスタムハンドラの MySessionHandler::destroy() メソッドが呼び出され、
158// サーバー上のセッションファイル（セッションデータ）が削除されます。
159if (session_destroy()) {
160    echo "サーバー上のセッションデータが正常に破棄されました。\n";
161
162    // セッションIDを保持するクッキーをクライアント（ブラウザ）から削除します。
163    // session_destroy() はサーバー側のセッションデータを削除しますが、クライアント側のセッションIDクッキーは自動的には削除しません。
164    // クッキーを削除するには、有効期限を過去に設定して setcookie() を呼び出す必要があります。
165    // 'session_name()' で現在のセッション名（デフォルトはPHPSESSID）を取得します。
166    setcookie(session_name(), '', [
167        'expires' => time() - 3600, // 有効期限を過去に設定して削除を指示
168        'path' => '/',              // クッキーのパス（通常はルートパス）
169        'domain' => '',             // クッキーのドメイン（空文字列は現在のドメインを使用）
170        'secure' => false,          // HTTPSを使用しない場合はfalse
171        'httponly' => true,         // JavaScriptからのアクセスを禁止
172        'samesite' => 'Lax'         // CSRF対策 (PHP 7.3+)
173    ]);
174    echo "クライアント（ブラウザ）のセッションIDクッキーを削除する指示を送信しました。\n";
175} else {
176    echo "セッションデータの破棄に失敗しました。\n";
177}
178
179// セッション破棄後、PHPの $_SESSION 変数はクリアされます。
180// また、セッションIDクッキーも削除されたため、次回アクセス時には新しいセッションが開始されます。
181
182echo "\n--- 破棄後のセッション状態 ---\n";
183// session_destroy() 呼び出し後も、session_id() は直前のセッションIDを返すことがありますが、
184// そのセッションIDはもはや有効ではなく、関連するデータもサーバーから削除されています。
185echo "session_id() の値 (現在は無効なIDを示す可能性あり): " . session_id() . "\n";
186echo "session_status(): " . (session_status() === PHP_SESSION_NONE ? 'PHP_SESSION_NONE (セッションなし)' : (session_status() === PHP_SESSION_ACTIVE ? 'PHP_SESSION_ACTIVE (セッションアクティブ)' : 'PHP_SESSION_DISABLED (セッション無効)')) . "\n";
187echo "セッション変数（\$_SESSION）の内容: ";
188print_r($_SESSION); // 通常は空の配列になります
189echo "\n";
190
191// このスクリプトをウェブサーバー経由で実行し、ブラウザのデベロッパーツールでクッキーの変化を確認すると、
192// セッションIDクッキーが削除されていることがわかります。
193
194// 注意: この例ではセッションデータを一時ディレクトリに保存しているため、
195// スクリプトの実行後もファイルが残る可能性があります。
196// 実際の運用では、ガベージコレクションや手動クリーンアップが必要です。
197// プログラムによるセッションパスのクリーンアップは通常、アプリケーションの終了時には行いません。
198// 例: rmdir($this->savePath); // この例のディレクトリは空でないと削除できないため、コメントアウトしています。
199?>

PHPのSessionHandlerInterface::destroyメソッドは、PHPのセッション管理を独自にカスタマイズする際に実装するインターフェースの一部です。このdestroyメソッドは、session_destroy()関数が呼び出されたときに、サーバー上に保存されている特定のセッションデータを削除するために使用されます。

引数string $idには、破棄するセッションを一意に識別するためのセッションIDが渡されます。このIDを使って、どのセッションのデータを削除すべきかを判断します。戻り値はbool型で、セッションデータの破棄に成功した場合はtrueを、失敗した場合はfalseを返します。

提供されたサンプルコードでは、MySessionHandlerクラスがファイルシステムにセッションデータを保存しており、destroyメソッドが呼び出されると、対応するセッションファイルがサーバーから削除されます。

重要な点として、session_destroy()関数やdestroyメソッドはサーバー側のセッションデータを削除するものであり、クライアント（ブラウザ）に保存されているセッションIDを保持するクッキー（PHPSESSIDなど）は自動的には削除されません。そのため、完全にセッションを終了させるには、サンプルコードのようにsetcookie()関数を用いて、セッションIDクッキーの有効期限を過去に設定し、クライアントから削除する指示も合わせて行う必要があります。これにより、サーバー側のセッションデータとクライアント側のセッションクッキーの両方が適切に「破棄」され、安全なログアウト処理などが実現されます。

Copy
1<?php
2
3/**
4 * カスタムセッションハンドラの実装例。
5 * SessionHandlerInterface を実装することで、PHPの標準セッションの動作をカスタマイズできます。
6 * この例では、セッションデータを一時ディレクトリ内のファイルとして保存・管理します。
7 */
8class MySessionHandler implements SessionHandlerInterface
9{
10    private string $savePath;
11
12    /**
13     * セッションのオープン時に呼び出されます。
14     * セッションデータの保存パスを設定し、必要であればディレクトリを作成します。
15     *
16     * @param string $save_path セッションデータの保存パス
17     * @param string $session_name セッション名 (この例では使用しません)
18     * @return bool 成功した場合は true、失敗した場合は false
19     */
20    public function open(string $save_path, string $session_name): bool
21    {
22        $this->savePath = $save_path;
23        if (!is_dir($this->savePath)) {
24            mkdir($this->savePath, 0777, true);
25        }
26        return true;
27    }
28
29    /**
30     * セッションのクローズ時に呼び出されます。
31     * この例では、特に何も行いませんが、データベース接続のクローズなどを行う場合があります。
32     *
33     * @return bool 成功した場合は true、失敗した場合は false
34     */
35    public function close(): bool
36    {
37        return true;
38    }
39
40    /**
41     * セッションデータの読み込み時に呼び出されます。
42     * 指定されたセッションIDに対応するデータをストレージから読み込みます。
43     *
44     * @param string $id セッションID
45     * @return string 読み込んだセッションデータ（見つからない場合は空文字列）
46     */
47    public function read(string $id): string
48    {
49        $file = $this->savePath . '/sess_' . $id;
50        if (file_exists($file)) {
51            return (string)file_get_contents($file);
52        }
53        return '';
54    }
55
56    /**
57     * セッションデータの書き込み時に呼び出されます。
58     * 指定されたセッションIDにデータをストレージに保存します。
59     *
60     * @param string $id セッションID
61     * @param string $data 保存するセッションデータ
62     * @return bool 成功した場合は true、失敗した場合は false
63     */
64    public function write(string $id, string $data): bool
65    {
66        $file = $this->savePath . '/sess_' . $id;
67        return file_put_contents($file, $data) !== false;
68    }
69
70    /**
71     * セッションデータの破棄時に呼び出されます (例: session_destroy() を呼び出した場合)。
72     * このメソッドは、指定されたセッションIDに対応するセッションデータを永続ストレージから削除します。
73     *
74     * @param string $id 破棄するセッションのID
75     * @return bool 成功した場合は true、失敗した場合は false
76     */
77    public function destroy(string $id): bool
78    {
79        $file = $this->savePath . '/sess_' . $id;
80        if (file_exists($file)) {
81            // ここでセッションファイルやデータベースのエントリなどを実際に削除します
82            unlink($file);
83            echo "[DEBUG] MySessionHandler::destroy() が呼び出されました。セッションID '{$id}' のファイルが削除されました。\n";
84        } else {
85            echo "[DEBUG] MySessionHandler::destroy() が呼び出されましたが、セッションID '{$id}' のデータは見つかりませんでした。\n";
86        }
87        return true;
88    }
89
90    /**
91     * ガベージコレクション (GC) 時に呼び出されます。
92     * 古いセッションデータをクリーンアップします。
93     *
94     * @param int $max_lifetime セッションの最大有効期間（秒）
95     * @return int|false クリーンアップされたセッションの数、または失敗した場合は false
96     */
97    public function gc(int $max_lifetime): int|false
98    {
99        $count = 0;
100        foreach (glob($this->savePath . '/sess_*') as $file) {
101            if (filemtime($file) + $max_lifetime < time() && is_file($file)) {
102                unlink($file);
103                $count++;
104            }
105        }
106        return $count;
107    }
108
109    /**
110     * 新しいセッションIDを生成する際に呼び出されます (PHP 7.1以降で必須)。
111     *
112     * @return string 新しいセッションID
113     */
114    public function create_sid(): string
115    {
116        return session_create_id();
117    }
118}
119
120// --- サンプルコードの実行部分 ---
121
122// 1. セッションデータを一時的に保存するディレクトリを設定します。
123//    実際のアプリケーションでは、より安全な永続ストレージ（データベースなど）を使用し、
124//    このディレクトリはPHPが書き込み権限を持つように設定します。
125$sessionSavePath = sys_get_temp_dir() . '/php_custom_sessions_example';
126if (!is_dir($sessionSavePath)) {
127    mkdir($sessionSavePath, 0777, true);
128    echo "セッション保存ディレクトリを作成しました: {$sessionSavePath}\n";
129}
130
131// 2. カスタムセッションハンドラのインスタンスを作成します。
132$handler = new MySessionHandler();
133
134// 3. PHPにこのカスタムハンドラを使用するよう指示します。
135//    第二引数 `true` は、既存のセッションハンドラ (通常はファイルベース) をこのカスタムハンドラに置き換えることを意味します。
136session_set_save_handler($handler, true);
137
138// 4. セッションを開始します。
139//    これにより、MySessionHandler::open() メソッドが呼び出されます。
140session_start();
141
142$currentSessionId = session_id();
143echo "現在のセッションID: {$currentSessionId}\n";
144
145// 5. セッションにデータを保存します。
146//    これにより、MySessionHandler::write() メソッドが呼び出されます。
147$_SESSION['user_id'] = 123;
148$_SESSION['username'] = 'beginner_se';
149echo "セッションにデータを書き込みました。\n";
150
151// セッションファイルが実際に作成されたことを確認
152$sessionFilePath = "{$sessionSavePath}/sess_{$currentSessionId}";
153if (file_exists($sessionFilePath)) {
154    echo "保存されたセッションファイルのパス: {$sessionFilePath}\n";
155    echo "セッションファイルの内容: " . file_get_contents($sessionFilePath) . "\n";
156} else {
157    echo "警告: セッションファイルが見つかりません (書き込みエラーの可能性)。\n";
158}
159
160echo "\n--- session_destroy() を呼び出してセッションを破棄します ---\n";
161
162// 6. session_destroy() を呼び出してセッションを破棄します。
163//    この呼び出しにより、MySessionHandler::destroy() メソッドが内部的に実行され、
164//    指定されたセッションIDのセッションデータが物理的にストレージから削除されます。
165session_destroy();
166
167echo "session_destroy() が呼び出されました。\n";
168
169// 7. セッション破棄後の状態を確認します。
170echo "\n--- 破棄後のセッション状態 ---\n";
171
172// session_id() はセッションが破棄されると空文字列を返すことがあります。
173echo "session_id() の値 (破棄後): " . session_id() . "\n";
174
175// $_SESSION 変数はクリアされます。
176if (isset($_SESSION['user_id'])) {
177    echo "エラー: セッションデータ 'user_id' が残っています。\n";
178} else {
179    echo "セッションデータがクリアされたことを確認しました (PHPスクリプト内)。\n";
180}
181
182// 物理的なセッションファイルが削除されたかを確認
183if (!file_exists($sessionFilePath)) {
184    echo "セッションファイルが物理的に削除されたことを確認しました。\n";
185} else {
186    echo "エラー: セッションファイルが物理的に残っています (MySessionHandler::destroy が正しく動作していない可能性)。\n";
187}
188
189// 8. サンプルで使用した一時ディレクトリとファイルをクリーンアップします。
190foreach (glob($sessionSavePath . '/*') as $file) {
191    if (is_file($file)) {
192        unlink($file);
193    }
194}
195if (is_dir($sessionSavePath)) {
196    rmdir($sessionSavePath);
197    echo "一時セッション保存ディレクトリ '{$sessionSavePath}' をクリーンアップしました。\n";
198}
199
200?>

PHP 8のSessionHandlerInterface::destroyメソッドは、PHPの標準セッション管理の動作をカスタマイズする「カスタムセッションハンドラ」を実装する際に用いられます。このメソッドは、session_destroy()関数が呼び出されたときに、サーバー側で管理されている特定のセッションデータを永続ストレージから完全に削除する役割を担います。

引数$idには、破棄対象となるセッションの一意なIDが文字列としてPHPから渡されます。カスタムハンドラはこのIDを用いて、ファイルシステム上のファイルやデータベースのエントリなど、セッションデータが保存されている場所から該当するデータを特定し、物理的に削除する処理を実装します。

メソッドの戻り値はbool型で、セッションデータの削除処理が成功した場合はtrueを、何らかの理由で失敗した場合はfalseを返す必要があります。この戻り値によって、PHPはセッション破棄処理の成否を適切に判断し、次の処理へ進むことができます。

サンプルコードでは、MySessionHandlerクラスがdestroyメソッド内で、一時ディレクトリに保存されたsess_プレフィックスを持つセッションファイルをunlink()関数で実際に削除しています。このようにdestroyメソッドを適切に実装することで、ユーザーがセッションを終了した際に、関連するサーバー側のセッションデータも確実にクリーンアップされる、安全で効率的なセッション管理システムを構築することが可能になります。