FlightPHP セッション - 軽量ファイルベースのセッションハンドラー

これは、Flight PHP Framework のための軽量なファイルベースのセッションハンドラープラグインです。これは、セッションの管理に関してシンプルでありながら強力なソリューションを提供し、ブロッキングしないセッションの読み取り、任意の暗号化、自動コミット機能、開発用のテストモードなどの機能を備えています。セッションデータはファイルに保存されるため、データベースを必要としないアプリケーションに最適です。

データベースを使用したい場合は、データベースバックエンドを持つこれらの同様の機能を多数備えたghostff/sessionプラグインをチェックしてください。

完全なソースコードと詳細は、Githubリポジトリを訪れてください。

Composerを介してプラグインをインストールします：

composer require flightphp/session

ここでは、Flightアプリケーションでflightphp/sessionプラグインを使用する簡単な例を示します：

require 'vendor/autoload.php';

use flight\Session;

$app = Flight::app();

// セッションサービスを登録
$app->register('session', Session::class);

// セッションを使用した例のルート
Flight::route('/login', function() {
    $session = Flight::session();
    $session->set('user_id', 123);
    $session->set('username', 'johndoe');
    $session->set('is_admin', false);

    echo $session->get('username'); // 出力: johndoe
    echo $session->get('preferences', 'default_theme'); // 出力: default_theme

    if ($session->get('user_id')) {
        Flight::json(['message' => 'ユーザーはログインしています！', 'user_id' => $session->get('user_id')]);
    }
});

Flight::route('/logout', function() {
    $session = Flight::session();
    $session->clear(); // すべてのセッションデータをクリア
    Flight::json(['message' => '正常にログアウトしました']);
});

Flight::start();

重要なポイント

• ノンブロッキング: セッションスタートのデフォルトとしてread_and_closeを使用し、セッションロックの問題を防ぎます。
• 自動コミット: デフォルトで有効になっており、無効にされない限り、シャットダウン時に変更が自動的に保存されます。
• ファイルストレージ: セッションはデフォルトで/flight_sessionsの下にあるシステムの一時ディレクトリに保存されます。

セッションハンドラーを登録する際に、オプションの配列を渡すことでカスタマイズできます：

$app->register('session', Session::class, [
    'save_path' => '/custom/path/to/sessions',         // セッションファイルのディレクトリ
    'encryption_key' => 'a-secure-32-byte-key-here',   // 暗号化を有効にする（AES-256-CBCに推奨される32バイト）
    'auto_commit' => false,                            // 手動制御のため自動コミットを無効にする
    'start_session' => true,                           // 自動的にセッションを開始する（デフォルト: true）
    'test_mode' => false                               // 開発用にテストモードを有効にする
]);

設定オプション

手動コミット

自動コミットを無効にすると、変更を手動でコミットする必要があります：

$app->register('session', Session::class, ['auto_commit' => false]);

Flight::route('/update', function() {
    $session = Flight::session();
    $session->set('key', 'value');
    $session->commit(); // 明示的に変更を保存
});

暗号化によるセッションのセキュリティ

機密データのために暗号化を有効にします：

$app->register('session', Session::class, [
    'encryption_key' => 'your-32-byte-secret-key-here'
]);

Flight::route('/secure', function() {
    $session = Flight::session();
    $session->set('credit_card', '4111-1111-1111-1111'); // 自動的に暗号化されます
    echo $session->get('credit_card'); // 取得時に復号化されます
});

セッション再生成

セキュリティのためにセッションIDを再生成します（例: ログイン後）：

Flight::route('/post-login', function() {
    $session = Flight::session();
    $session->regenerate(); // 新しいID、データを保持
    // または
    $session->regenerate(true); // 新しいID、古いデータを削除
});

ミドルウェアの例

セッションベースの認証でルートを保護します：

Flight::route('/admin', function() {
    Flight::json(['message' => '管理パネルへようこそ']);
})->addMiddleware(function() {
    $session = Flight::session();
    if (!$session->get('is_admin')) {
        Flight::halt(403, 'アクセス拒否');
    }
});

これはミドルウェアでの使い方の簡単な例です。詳細な例については、ミドルウェアのドキュメントを参照してください。

Sessionクラスは以下のメソッドを提供します：

• set(string $key, $value): セッションに値を保存します。
• get(string $key, $default = null): 値を取得し、キーが存在しない場合のオプションのデフォルトを提供します。
• delete(string $key): セッションから特定のキーを削除します。
• clear(): すべてのセッションデータを削除します。
• commit(): 現在のセッションデータをファイルシステムに保存します。
• id(): 現在のセッションIDを返します。
• regenerate(bool $deleteOld = false): セッションIDを再生成し、オプションで古いデータを削除します。

get()とid()を除くすべてのメソッドは、チェーンのためにSessionインスタンスを返します。

貢献は歓迎します！リポジトリをフォークし、変更を加えてプルリクエストを送信してください。バグを報告するか、Githubのイシュートラッカーを通じて機能を提案してください。

このプラグインはMITライセンスの下でライセンスされています。詳細については、Githubリポジトリを参照してください。