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

Copy
1<?php
2
3/**
4 * カスタムセッションハンドラの例です。
5 * SessionHandler を継承し、セッションデータの保存と読み込みをファイルシステムで行います。
6 *
7 * SessionHandler::read メソッドは、PHPのセッション管理機構によって、
8 * 指定されたセッションIDに対応するセッションデータを読み込む際に呼び出されます。
9 * キーワードにある `readfile` 関数とは異なり、SessionHandler::read は
10 * ファイルの内容を直接出力するのではなく、セッションデータを文字列として返します。
11 *
12 * システムエンジニアを目指す初心者の方へ:
13 * セッションハンドラは、PHPの標準的なセッション保存方法（通常はファイル）を
14 * データベースやキャッシュサーバーなど、他の方法にカスタマイズしたい場合に利用します。
15 */
16class MyFileSessionHandler extends SessionHandler
17{
18    /** @var string セッションファイルの保存パス */
19    private string $savePath;
20
21    /**
22     * セッションを開く際にPHPによって呼び出されます。
23     * カスタムハンドラの初期設定を行います。
24     *
25     * @param string $savePath PHPの設定 'session.save_path' で指定されたパス
26     * @param string $name     PHPの設定 'session.name' で指定されたセッション名
27     * @return bool 成功時に true、失敗時に false
28     */
29    public function open(string $savePath, string $name): bool
30    {
31        // この例では、システムの一時ディレクトリ内に 'my_sessions' ディレクトリを作成し、
32        // セッションファイルの保存パスとして利用します。
33        $this->savePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'my_sessions';
34        if (!is_dir($this->savePath)) {
35            // ディレクトリが存在しない場合は作成します。
36            mkdir($this->savePath, 0700, true);
37        }
38        return true;
39    }
40
41    /**
42     * セッションデータを読み込みます。
43     * session_start() が呼び出された際にPHPによって内部的に実行されます。
44     * このメソッドの戻り値は、$_SESSION 変数に展開されるセッションデータとなります。
45     *
46     * @param string $id 読み込むセッションのID (例: phpsessid の値)
47     * @return string|false セッションデータ（シリアライズされた文字列）、
48     *                      データがない場合は空文字列、失敗時は false を返します。
49     */
50    public function read(string $id): string|false
51    {
52        // セッションIDに基づいて、セッションファイルを保存するフルパスを構築します。
53        $sessionFilePath = $this->savePath . DIRECTORY_SEPARATOR . 'sess_' . $id;
54
55        // 指定されたパスにセッションファイルが存在し、読み込み可能であればその内容を返します。
56        if (file_exists($sessionFilePath) && is_readable($sessionFilePath)) {
57            // file_get_contents() はファイルの内容を文字列として読み込みます。
58            // これが SessionHandler::read の期待される戻り値の形式です。
59            return (string)file_get_contents($sessionFilePath);
60        }
61
62        // セッションデータが見つからない場合（例えば新しいセッションの場合）は、
63        // PHPのセッション管理機構が期待する通り、空文字列を返します。
64        return '';
65    }
66
67    /**
68     * セッションデータを書き込みます。
69     * スクリプト終了時や session_write_close() が呼び出された際にPHPによって内部的に実行されます。
70     *
71     * @param string $id   書き込むセッションのID
72     * @param string $data PHPによってシリアライズされたセッションデータ
73     * @return bool 成功時に true、失敗時に false
74     */
75    public function write(string $id, string $data): bool
76    {
77        $sessionFilePath = $this->savePath . DIRECTORY_SEPARATOR . 'sess_' . $id;
78        // file_put_contents() でファイルにデータを書き込みます。
79        // LOCK_EX は、他のプロセスからの同時書き込みを防ぐための排他ロックです。
80        return (bool)file_put_contents($sessionFilePath, $data, LOCK_EX);
81    }
82
83    /**
84     * セッションを閉じる際にPHPによって呼び出されます。
85     *
86     * @return bool 成功時に true、失敗時に false
87     */
88    public function close(): bool
89    {
90        // この例では、閉じる際に特別なリソースのクリーンアップは不要です。
91        return true;
92    }
93
94    /**
95     * セッションを破棄（削除）する際にPHPによって呼び出されます。
96     * session_destroy() が呼び出された際に実行されます。
97     *
98     * @param string $id 破棄するセッションのID
99     * @return bool 成功時に true、失敗時に false
100     */
101    public function destroy(string $id): bool
102    {
103        $sessionFilePath = $this->savePath . DIRECTORY_SEPARATOR . 'sess_' . $id;
104        if (file_exists($sessionFilePath)) {
105            return unlink($sessionFilePath); // セッションファイルを削除します。
106        }
107        return true; // ファイルが存在しない場合も、既に破棄されているとみなして成功とします。
108    }
109
110    /**
111     * ガベージコレクション (GC) を実行します。
112     * 古いセッションデータを削除するために、一定の確率でPHPによって呼び出されます。
113     *
114     * @param int $maxLifetime セッションの最大有効期限（秒）
115     * @return int|false 削除されたセッションファイルの数、または失敗時に false
116     */
117    public function gc(int $maxLifetime): int|false
118    {
119        $deletedCount = 0;
120        // 保存パス内のすべてのセッションファイルを検索します。
121        foreach (glob($this->savePath . DIRECTORY_SEPARATOR . 'sess_*') as $file) {
122            // ファイルの最終更新時刻が最大有効期限よりも古ければ削除します。
123            if (file_exists($file) && filemtime($file) + $maxLifetime < time()) {
124                unlink($file);
125                $deletedCount++;
126            }
127        }
128        return $deletedCount;
129    }
130}
131
132// --- MyFileSessionHandler の利用例 ---
133
134// 1. カスタムセッションハンドラのインスタンスを作成します。
135$handler = new MyFileSessionHandler();
136
137// 2. PHPのセッション管理にカスタムハンドラを登録します。
138//    これにより、以降のセッション操作（session_start() や $_SESSION へのアクセスなど）は
139//    MyFileSessionHandler の各メソッドを通じて行われるようになります。
140//    第2引数の true は、デフォルトのセッションハンドラを自動的に登録するかどうかを示します。
141session_set_save_handler($handler, true);
142
143// 3. セッションを開始します。
144//    この時点で MyFileSessionHandler::open() が呼び出された後、
145//    現在のセッションID（または新しいセッションID）に基づいて
146//    MyFileSessionHandler::read() がPHPによって内部的に呼び出されます。
147//    read() は既存のセッションデータを読み込み、それを $_SESSION 変数に展開します。
148session_start();
149
150// 現在のセッションIDを取得して表示します。
151$sessionId = session_id();
152echo "現在のセッションID: " . $sessionId . "\n";
153
154// セッション変数に値を設定または更新します。
155// この $_SESSION へのアクセスは、MyFileSessionHandler::read() で読み込んだデータ、
156// または新しいセッションであれば空の状態で利用されます。
157if (!isset($_SESSION['access_count'])) {
158    $_SESSION['access_count'] = 1;
159    echo "これは初めてのアクセスです。現在のアクセス数: " . $_SESSION['access_count'] . "\n";
160} else {
161    $_SESSION['access_count']++;
162    echo "再度アクセスしました。現在のアクセス数: " . $_SESSION['access_count'] . "\n";
163}
164
165// 注意: MyFileSessionHandler::write() は、通常、スクリプトの実行が終了する際、
166// または session_write_close() が明示的に呼び出される際に、PHPによって自動的に呼び出されます。
167// MyFileSessionHandler::read() がセッションデータを正しく読み込んでいることは、
168// 同じブラウザでこのスクリプトを複数回実行し、'access_count' の値が増加することで確認できます。
169// これは、前回のセッションデータがファイルから読み込まれ、$_SESSION に復元されていることを意味します。
170?>

PHPのSessionHandler::readメソッドは、session_start()が呼び出された際に、PHPのセッション管理機構がセッションデータを読み込むために内部的に実行する拡張メソッドです。このメソッドは、SessionHandlerクラスを継承したカスタムセッションハンドラ内で実装されます。

引数$idには、読み込みたいセッションの一意なIDが文字列で渡されます。戻り値はstring型またはfalse型です。成功した場合は、シリアライズされたセッションデータを文字列として返します。データが存在しない場合は空文字列（''）を、読み込み失敗時はfalseを返します。

キーワードにあるphp readfile関数とは異なり、このreadメソッドはファイルの内容を直接出力するのではなく、PHPの内部処理のためにセッションデータを文字列として提供する点が特徴です。

サンプルコードのMyFileSessionHandlerでは、セッションIDに基づいてセッションファイルからデータを読み込み、文字列として返却しています。この戻り値はPHPによってデシリアライズされ、$_SESSION変数にセッション状態が復元されます。このメソッドを実装することで、PHPの標準的なセッション保存方法（通常はファイル）をデータベースやキャッシュサーバーなど、別の方法にカスタマイズすることが可能になります。

Copy
1<?php
2
3/**
4 * カスタムファイルベースセッションハンドラ
5 *
6 * SessionHandlerInterface を実装し、セッションデータをファイルに保存・読み込みます。
7 * PHPのセッション管理を独自の方法でカスタマイズする際に利用します。
8 *
9 * このクラスは、セッションファイルを保存するディレクトリパスを readonly プロパティとして持ちます。
10 * readonly プロパティはPHP 8.1で導入され、一度初期化されると変更できないことを保証します。
11 */
12class CustomFileSessionHandler implements SessionHandlerInterface
13{
14    /**
15     * セッションファイルを保存するディレクトリパス。
16     * readonly であるため、コンストラクタで初期化された後は変更されません。
17     *
18     * @var string
19     */
20    private readonly string $sessionSavePath;
21
22    /**
23     * コンストラクタ
24     *
25     * @param string $sessionSavePath セッションファイルを保存するディレクトリのパス
26     */
27    public function __construct(string $sessionSavePath)
28    {
29        $this->sessionSavePath = $sessionSavePath;
30
31        // セッション保存パスが存在しない場合は作成します。
32        if (!is_dir($this->sessionSavePath)) {
33            mkdir($this->sessionSavePath, 0777, true);
34        }
35    }
36
37    /**
38     * セッションを開く
39     *
40     * @param string $path セッションの保存パス (通常は php.ini の session.save_path)
41     * @param string $name セッション名 (通常は PHPSESSID)
42     * @return bool 成功した場合に true
43     */
44    public function open(string $path, string $name): bool
45    {
46        // このカスタムハンドラでは、特別なオープン処理は不要です。
47        // 必要に応じて、データベース接続の確立などが行われます。
48        return true;
49    }
50
51    /**
52     * セッションを閉じる
53     *
54     * @return bool 成功した場合に true
55     */
56    public function close(): bool
57    {
58        // このカスタムハンドラでは、特別なクリーンアップ処理は不要です。
59        // 必要に応じて、データベース接続の切断などが行われます。
60        return true;
61    }
62
63    /**
64     * セッションデータを読み込む
65     *
66     * 指定されたセッションIDに対応するセッションデータを読み込み、文字列として返します。
67     * データが存在しない場合は空文字列を返します。読み込みに失敗した場合は false を返します。
68     *
69     * @param string $id 読み込むセッションのID
70     * @return string|false 読み込んだセッションデータ、または失敗時に false
71     */
72    public function read(string $id): string|false
73    {
74        $filePath = $this->sessionSavePath . '/' . $id . '.sess';
75
76        // セッションファイルが存在するか確認
77        if (file_exists($filePath)) {
78            // ファイルから内容を読み込む
79            $data = file_get_contents($filePath);
80            if ($data === false) {
81                // ファイル読み込みに失敗した場合
82                error_log("Failed to read session file: " . $filePath);
83                return false;
84            }
85            return $data;
86        }
87
88        // データが存在しない場合は空文字列を返すのがPHPセッションハンドラの標準的な動作
89        return '';
90    }
91
92    /**
93     * セッションデータを書き込む
94     *
95     * 指定されたセッションIDでデータを保存します。
96     *
97     * @param string $id 書き込むセッションのID
98     * @param string $data 保存するセッションデータ
99     * @return bool 成功した場合に true
100     */
101    public function write(string $id, string $data): bool
102    {
103        $filePath = $this->sessionSavePath . '/' . $id . '.sess';
104        // ファイルにデータを書き込む
105        return file_put_contents($filePath, $data) !== false;
106    }
107
108    /**
109     * セッションを破棄する
110     *
111     * 指定されたセッションIDに対応するセッションファイルを削除します。
112     *
113     * @param string $id 破棄するセッションのID
114     * @return bool 成功した場合に true
115     */
116    public function destroy(string $id): bool
117    {
118        $filePath = $this->sessionSavePath . '/' . $id . '.sess';
119        if (file_exists($filePath)) {
120            return unlink($filePath);
121        }
122        // ファイルが存在しない場合は、すでに破棄されていると見なして成功とする
123        return true;
124    }
125
126    /**
127     * ガーベージコレクション (GC) を実行する
128     *
129     * 指定された最大有効期間を超過した古いセッションファイルを削除します。
130     *
131     * @param int $max_lifetime セッションの最大有効期間 (秒)
132     * @return int|false 削除されたセッションファイルの数、または失敗時に false
133     */
134    public function gc(int $max_lifetime): int|false
135    {
136        $deletedCount = 0;
137        foreach (glob($this->sessionSavePath . '/*.sess') as $file) {
138            // ファイルの最終更新時刻が max_lifetime より古い場合
139            if (filemtime($file) + $max_lifetime < time()) {
140                unlink($file);
141                $deletedCount++;
142            }
143        }
144        return $deletedCount;
145    }
146}
147
148/**
149 * カスタムセッションハンドラを使用するサンプルコードを実行する関数
150 */
151function runCustomSessionExample(): void
152{
153    // セッションファイルを保存する一時ディレクトリを指定します。
154    // 環境に合わせて適切なパスに変更してください (例: '/tmp/my_sessions', 'C:/temp/my_sessions')
155    // __DIR__ は現在のスクリプトがあるディレクトリを指します。
156    $sessionSavePath = __DIR__ . '/_custom_sessions';
157
158    // カスタムセッションハンドラのインスタンスを作成します。
159    $handler = new CustomFileSessionHandler($sessionSavePath);
160
161    // PHPのセッションハンドラをカスタムハンドラに設定します。
162    // 2番目の引数 true は、スクリプト終了時に自動的にセッションハンドラを登録解除することを意味します。
163    session_set_save_handler($handler, true);
164
165    // セッションを開始します。
166    // これにより、PHP内部で SessionHandlerInterface の open および read メソッドが呼び出されます。
167    session_start();
168
169    // セッションデータの設定と読み込みの例
170    if (!isset($_SESSION['visits'])) {
171        echo "<h1>初めての訪問です！</h1>";
172        $_SESSION['visits'] = 1;
173        $_SESSION['message'] = 'Hello from Custom Session Handler!';
174    } else {
175        $_SESSION['visits']++;
176        echo "<h1>おかえりなさい！</h1>";
177    }
178
179    echo "<p>現在の訪問回数: " . $_SESSION['visits'] . "</p>";
180    echo "<p>メッセージ: " . $_SESSION['message'] . "</p>";
181    echo "<p>現在のセッションID: " . session_id() . "</p>";
182
183    // セッションデータを保存し、セッションを閉じます。
184    // これにより、PHP内部で SessionHandlerInterface の write および close メソッドが呼び出されます。
185    session_write_close();
186
187    echo "<hr>";
188    echo "<p>このページをリロードすると、訪問回数が増加します。</p>";
189    echo "<p>セッションデータは、ディレクトリ「<code>" . htmlspecialchars($sessionSavePath) . "</code>」にファイルとして保存されています。</p>";
190}
191
192// サンプルコードを実行します。
193runCustomSessionExample();
194
195// 注意: このサンプルコードは開発環境でのデモンストレーションを目的としています。
196// 実際の運用環境では、セッションディレクトリのパーミッション管理や、
197// より堅牢なエラーハンドリングなどを考慮する必要があります。
198?>

このPHPサンプルコードは、PHPの標準セッション管理の仕組みを独自にカスタマイズする方法を、初心者向けにファイルベースの例で示しています。SessionHandlerInterfaceを実装したCustomFileSessionHandlerクラスを作成し、セッションデータをファイルに保存・読み込む動作を定義しています。

クラス内のsessionSavePathプロパティは、PHP 8.1で導入されたreadonly修飾子が付与されており、オブジェクトの初期化時のみ値を設定でき、その後は変更できないことを保証しています。これにより、セッションファイルの保存先パスが不意に書き換えられることを防ぎ、安全性を高めています。

このサンプルコードの中心であるreadメソッドは、セッション管理において非常に重要な役割を担います。readメソッドは、引数として渡されたstring $id（セッションを特定するユニークなID）に基づいて、対応するセッションデータが保存されているファイルを読み込みます。メソッドの戻り値は、読み込んだセッションデータがstring型で返されるか、該当するデータが存在しない場合には空文字列を返します。もしファイルの読み込み自体に失敗した場合はfalseを返します。

runCustomSessionExample関数では、このCustomFileSessionHandlerインスタンスをsession_set_save_handler関数でPHPのセッションハンドラとして登録しています。その後session_start()を呼び出すことで、PHPは内部的にカスタムハンドラのopenメソッドとこのreadメソッドを呼び出し、セッションの初期化とデータの読み込みを行います。これにより、$_SESSION変数を通じてセッションデータにアクセスできるようになります。