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

Copy
1<?php
2
3/**
4 * MyCustomSessionHandler クラスは SessionHandler を継承し、
5 * セッションの保存、読み込み、破棄などの動作をカスタマイズします。
6 * この例では、ファイルベースのセッションストレージを模倣します。
7 */
8class MyCustomSessionHandler extends SessionHandler
9{
10    private string $savePath;
11
12    /**
13     * コンストラクタでセッションデータの保存パスを設定し、必要であればディレクトリを作成します。
14     *
15     * @param string $savePath セッションファイルを保存するディレクトリ
16     */
17    public function __construct(string $savePath = 'sess_data')
18    {
19        // セッションデータを保存するディレクトリを設定
20        $this->savePath = rtrim($savePath, '/') . '/';
21        if (!is_dir($this->savePath)) {
22            mkdir($this->savePath, 0777, true);
23        }
24    }
25
26    /**
27     * セッションを開きます。
28     * この実装では、ディレクトリの存在確認をコンストラクタで行っているため、常にtrueを返します。
29     *
30     * @param string $path 現在のセッション保存パス
31     * @param string $name 現在のセッション名
32     * @return bool 成功した場合はtrue、失敗した場合はfalse
33     */
34    public function open(string $path, string $name): bool
35    {
36        return true;
37    }
38
39    /**
40     * セッションを閉じます。
41     * 特にクリーンアップ作業がなければtrueを返します。
42     *
43     * @return bool 成功した場合はtrue、失敗した場合はfalse
44     */
45    public function close(): bool
46    {
47        return true;
48    }
49
50    /**
51     * セッションIDに対応するセッションデータを読み込みます。
52     *
53     * @param string $id セッションID
54     * @return string 読み込んだセッションデータ、またはデータが存在しない場合は空文字列
55     */
56    public function read(string $id): string
57    {
58        $file = $this->savePath . 'sess_' . $id;
59        if (file_exists($file)) {
60            return (string) file_get_contents($file);
61        }
62        return '';
63    }
64
65    /**
66     * セッションIDとデータを受け取り、セッションストレージに書き込みます。
67     *
68     * @param string $id セッションID
69     * @param string $data 書き込むセッションデータ
70     * @return bool 成功した場合はtrue、失敗した場合はfalse
71     */
72    public function write(string $id, string $data): bool
73    {
74        $file = $this->savePath . 'sess_' . $id;
75        return (bool) file_put_contents($file, $data);
76    }
77
78    /**
79     * 指定されたセッションIDのセッションデータを破棄します。
80     * このメソッドは `session_destroy()` 関数が呼び出されたときに、
81     * 現在のセッションIDを引数としてPHPによって自動的に呼び出されます。
82     *
83     * @param string $id 破棄するセッションのID
84     * @return bool 成功した場合はtrue、失敗した場合はfalse
85     */
86    public function destroy(string $id): bool
87    {
88        $file = $this->savePath . 'sess_' . $id;
89        if (file_exists($file)) {
90            // セッションファイルが存在すれば削除を試みる
91            return unlink($file);
92        }
93        // ファイルが存在しない場合も、既に破棄済みとみなしtrueを返す
94        return true;
95    }
96
97    /**
98     * ガーベージコレクションを実行し、古いセッションデータを削除します。
99     *
100     * @param int $max_lifetime セッションの最大有効期間（秒）
101     * @return int 削除されたセッションの数
102     */
103    public function gc(int $max_lifetime): int
104    {
105        $count = 0;
106        foreach (glob($this->savePath . 'sess_*') as $file) {
107            // ファイルの最終更新時刻が max_lifetime より古い場合に削除
108            if (filemtime($file) + $max_lifetime < time() && file_exists($file)) {
109                unlink($file);
110                $count++;
111            }
112        }
113        return $count;
114    }
115}
116
117// ------------------- サンプルコードの実行部分 -------------------
118
119// 1. カスタムセッションハンドラをインスタンス化
120//    'temp_sessions' という一時的なディレクトリにセッションデータを保存します。
121$handler = new MyCustomSessionHandler('temp_sessions');
122
123// 2. このカスタムハンドラをPHPのセッション管理に登録します。
124//    `true` を指定することで、既存のセッションハンドラが置き換えられます。
125session_set_save_handler($handler, true);
126
127// 3. セッションを開始します。
128session_start();
129
130echo "<h3>セッションの開始とデータ設定</h3>";
131
132// 現在のセッションIDを表示
133echo "現在のセッションID: " . session_id() . "<br>";
134
135// セッションにデータを設定
136$_SESSION['username'] = '初心者SE';
137$_SESSION['login_time'] = time();
138
139echo "設定されたセッションデータ: <br>";
140echo "username: " . ($_SESSION['username'] ?? '未設定') . "<br>";
141echo "login_time: " . ($_SESSION['login_time'] ?? '未設定') . "<br>";
142
143echo "<hr>";
144
145echo "<h3>セッションの破棄 (session_destroy() を通じて SessionHandler::destroy が呼び出される)</h3>";
146
147// セッションを破棄します。
148// この関数が呼び出されると、登録されたカスタムハンドラの `destroy` メソッドが
149// 現在のセッションIDを引数に自動的に呼び出され、サーバー上のセッションデータが削除されます。
150if (session_destroy()) {
151    echo "セッションデータはサーバー上で破棄されました。<br>";
152} else {
153    echo "セッションデータの破棄に失敗しました。<br>";
154}
155
156// キーワード「php destroy cookie」に対応するため、
157// セッションIDを保持するクッキーもクライアント側で破棄するよう指示します。
158// これにより、ブラウザは次回のリクエストで古いセッションIDを送信しなくなります。
159$session_cookie_params = session_get_cookie_params();
160if (isset($_COOKIE[session_name()])) {
161    setcookie(
162        session_name(), // セッション名 (通常は PHPSESSID)
163        '',             // 値を空にする
164        time() - 3600,  // 有効期限を過去にする (即時削除)
165        $session_cookie_params['path'],
166        $session_cookie_params['domain'],
167        $session_cookie_params['secure'],
168        $session_cookie_params['httponly']
169    );
170    echo "セッションクッキーもブラウザから削除するよう指示しました。<br>";
171}
172
173// `session_destroy()` の後でも $_SESSION 変数自体がクリアされていない場合があるため、
174// 念のため明示的に空の配列を代入してセッション変数をクリアします。
175$_SESSION = [];
176
177echo "<hr>";
178
179echo "<h3>破棄後のセッション状態確認</h3>";
180// 破棄されたセッションデータは利用できません。
181echo "破棄後のセッションID (通常は空): " . session_id() . "<br>";
182echo "username: " . ($_SESSION['username'] ?? '未設定') . "<br>"; // 未設定と表示されるはず
183echo "login_time: " . ($_SESSION['login_time'] ?? '未設定') . "<br>"; // 未設定と表示されるはず
184
185// スクリプトの実行後、`temp_sessions` ディレクトリとその中のセッションファイルが
186// この例では自動的に作成され、セッション破棄時に削除されることを確認できます。
187?>

PHPのSessionHandler::destroyメソッドは、サーバー側に保存されている特定のセッションデータを完全に削除する役割を持ちます。このメソッドは、開発者が直接呼び出すことは少なく、PHPの組み込み関数であるsession_destroy()が実行された際に、現在アクティブなセッションのIDを引数としてPHPによって自動的に呼び出されます。

引数$idには、破棄したいセッションの一意の識別子であるセッションIDが文字列として渡されます。メソッドの実装では、このIDに対応するセッションファイルやデータベースエントリなどを検索し、削除処理を実行します。

戻り値はbool型で、セッションデータの破棄に成功した場合はtrueを、失敗した場合はfalseを返します。サンプルコードでは、指定されたセッションIDに対応するファイルが存在すればunlink()関数で削除し、その成否を返しています。ファイルが存在しない場合でも、既にデータがない状態とみなしtrueを返して正常終了とします。

セッションを完全に終了させるには、session_destroy()でサーバー側のデータを削除するだけでなく、クライアント（ブラウザ）に保存されているセッションIDを保持するクッキーも削除するよう指示する必要があります。これにより、ブラウザは古いセッションIDを送信しなくなり、完全にログアウト状態となります。

Copy
1<?php
2
3/**
4 * SessionHandler を継承したカスタムセッションハンドラ。
5 * PHPの標準セッション処理を独自のロジックで上書きするために使用されます。
6 */
7class MyCustomSessionHandler extends SessionHandler
8{
9    /**
10     * セッションを破棄するメソッド。
11     * 指定されたセッションIDに対応するセッションデータを削除します。
12     *
13     * システムエンジニアの初心者向け解説:
14     * このメソッドは、PHPの session_destroy() 関数が呼び出された際に、
15     * session_set_save_handler() で登録したカスタムハンドラの代わりに呼び出されます。
16     * ここに、ファイルシステムやデータベースなど、セッションデータの保存場所から
17     * 実際のデータを削除するロジックを記述します。
18     *
19     * @param string $id 破棄するセッションの一意なID
20     * @return bool データの破棄に成功した場合は true、失敗した場合は false
21     */
22    public function destroy(string $id): bool
23    {
24        echo "MyCustomSessionHandler::destroy() が呼び出されました。破棄対象のセッションID: '{$id}'\n";
25
26        // ここに実際のセッションデータ破棄ロジックを実装します。
27        // 例: ファイルを削除、データベースのレコードを削除など。
28        // 親クラス (SessionHandler) のデフォルトの破棄ロジックを呼び出すことも可能です。
29        // 例: return parent::destroy($id);
30
31        // このサンプルでは、データ破棄が成功したと仮定して true を返します。
32        return true;
33    }
34
35    // 他のセッションハンドラメソッド (open, read, write, close, gc) は
36    // 親クラスである SessionHandler のデフォルト実装を使用します。
37    // 必要に応じて、これらのメソッドもオーバーライドしてカスタマイズできます。
38}
39
40// 1. カスタムセッションハンドラのインスタンスを作成します。
41$customHandler = new MyCustomSessionHandler();
42
43// 2. 作成したカスタムハンドラをPHPのセッション管理に登録します。
44// これにより、以降の session_start() や session_destroy() の呼び出しで、
45// このカスタムハンドラの対応するメソッドが使用されるようになります。
46// 第2引数 'true' は、セッションハンドラを自動登録することを示します。
47session_set_save_handler($customHandler, true);
48
49echo "セッションを開始します...\n";
50// 3. セッションを開始します。
51// これにより、セッションIDが生成され、カスタムハンドラの open() メソッドが呼ばれます。
52session_start();
53
54// 4. セッション変数にデータを設定します。
55$_SESSION['user_id'] = 1001;
56$_SESSION['username'] = 'sampleuser';
57echo "セッションID: " . session_id() . "\n";
58echo "セッションにデータを設定しました: " . print_r($_SESSION, true);
59
60echo "セッションを破棄します...\n";
61// 5. セッションを破棄します。
62// この関数が呼び出されると、登録したカスタムハンドラの destroy() メソッドが
63// PHPの内部で呼び出され、セッションIDに基づいてデータが削除されます。
64session_destroy();
65
66// session_destroy() は $_SESSION 変数を空にするだけで、
67// セッションクッキーは削除しません。
68// クッキーを完全に削除するには、setcookie() を使用する必要がありますが、
69// destroy() メソッドの動作確認には必須ではないため、ここでは省略します。
70
71echo "セッション破棄後の $_SESSION 配列の内容: " . print_r($_SESSION, true);
72echo "スクリプトの実行が完了しました。\n";
73
74?>

SessionHandler::destroyは、PHP 8で提供されるカスタムセッションハンドラを実装する際に利用されるメソッドです。このメソッドは、SessionHandlerクラスを継承した独自のクラス内で定義され、指定されたセッションIDに対応するセッションデータを、ファイルシステムやデータベースなどの永続的な保存場所から削除する役割を担います。

このメソッドが実際に呼び出されるのは、session_set_save_handler()関数を使ってカスタムセッションハンドラをPHPに登録し、その後にsession_destroy()関数が実行された時です。引数string $idには、破棄すべきセッションを一意に識別するIDがPHPから渡されます。開発者はこの$idを用いて、保存されている実際のセッションデータ（例：特定のファイルやデータベースのレコード）を特定し、削除するロジックをこのメソッド内に記述します。

メソッドの戻り値はbool型で、セッションデータの破棄処理が成功した場合はtrueを、失敗した場合はfalseを返します。サンプルコードでは、MyCustomSessionHandlerクラスがSessionHandlerを継承し、destroyメソッドをオーバーライドしています。session_start()でセッションが開始されデータが設定された後、session_destroy()が呼び出されると、このカスタムdestroyメソッドがPHPによって実行され、指定されたセッションIDに対するデータ削除処理が模擬的に行われる様子を確認できます。これにより、PHP標準のセッション管理を独自の要件に合わせて柔軟にカスタマイズすることが可能です。