【PHP8.x】session_id関数の使い方

<?php

/**
 * セッションIDを安全にエンコード・デコードするクラス
 */
class SessionIdHandler {

    /**
     * セッションIDを取得または設定する
     *
     * @param string|null $id 設定するセッションID (nullの場合は現在のIDを返す)
     * @return string|false 成功時はセッションID、失敗時はfalse
     */
    public static function sessionId(?string $id = null): string|false
    {
        if ($id === null) {
            // セッションIDを取得して返す
            return session_id();
        } else {
            // セッションIDを設定する
            if (session_id($id)) {
                return session_id(); // 設定されたIDを返す
            } else {
                return false; // 設定に失敗した場合
            }
        }
    }

    /**
     * セッションIDが有効な形式かどうかを検証する
     *
     * @param string $id 検証するセッションID
     * @return bool 有効な形式の場合はtrue、そうでない場合はfalse
     */
    public static function isValidSessionId(string $id): bool
    {
        // 簡単な形式チェック (より厳密な検証が必要な場合は正規表現などを利用)
        return preg_match('/^[a-zA-Z0-9,-]{22,128}$/', $id) === 1;
    }

    /**
     * セッションIDを生成する
     *
     * @return string 生成されたセッションID
     */
    public static function generateSessionId(): string
    {
        // より安全な方法でセッションIDを生成するためにrandom_bytesを使用
        return bin2hex(random_bytes(32)); // 64文字の16進数文字列を生成
    }
}

// 使用例：
session_start(); // セッションを開始 (セッションIDの設定/取得前に必要)

// 新しいセッションIDを生成
$newSessionId = SessionIdHandler::generateSessionId();
echo "生成されたセッションID: " . $newSessionId . "\n";

// セッションIDを設定
if (SessionIdHandler::sessionId($newSessionId) !== false) {
    echo "セッションIDが設定されました。\n";
} else {
    echo "セッションIDの設定に失敗しました。\n";
}

// 現在のセッションIDを取得
$currentSessionId = SessionIdHandler::sessionId();
echo "現在のセッションID: " . $currentSessionId . "\n";

// セッションIDの形式を検証
$isValid = SessionIdHandler::isValidSessionId($currentSessionId);
echo "セッションIDは有効な形式ですか？: " . ($isValid ? 'はい' : 'いいえ') . "\n";

session_id()関数は、現在のセッションIDを取得または設定するために使用します。引数$idに文字列を渡すと、その文字列が新しいセッションIDとして設定されます。$idにnullを渡すか、引数を省略した場合は、現在のセッションIDが返されます。

サンプルコードでは、SessionIdHandlerクラスを通じて、セッションIDの生成、設定、取得、検証を行う方法を示しています。generateSessionId()メソッドは、random_bytes()関数を使用して安全なセッションIDを生成します。sessionId()メソッドは、セッションIDの設定と取得を行います。isValidSessionId()メソッドは、セッションIDが有効な形式であるかを検証します。

セッションIDを設定する前にsession_start()関数を呼び出してセッションを開始する必要があります。sessionId()関数に新しいセッションIDを渡すと、セッションIDが変更されます。設定に成功した場合は、設定されたセッションIDが返されます。失敗した場合はfalseが返されます。引数なしでsessionId()関数を呼び出すと、現在のセッションIDが返されます。isValidSessionId()関数は、正規表現を用いてセッションIDの形式をチェックし、有効な形式であればtrue、そうでなければfalseを返します。

<?php

/**
 * セッションIDの取得と設定の例.
 */
function session_id_example(): void
{
    // 現在のセッションIDを取得する
    $currentSessionId = session_id();

    // セッションが開始されていない場合、空文字列が返る
    if ($currentSessionId === '') {
        echo "セッションは開始されていません。\n";
    } else {
        echo "現在のセッションID: " . $currentSessionId . "\n";
    }

    // 新しいセッションIDを設定する (セッション開始前にのみ可能)
    $newSessionId = 'mynewsessionid123';
    session_id($newSessionId);

    // 設定されたセッションIDを確認する
    $sessionIdAfterSetting = session_id();
    echo "設定後のセッションID: " . $sessionIdAfterSetting . "\n";

    // セッションを開始する
    session_start();

    // セッション開始後にsession_id()を呼ぶと、実際のセッションIDが返る
    $realSessionId = session_id();
    echo "セッション開始後のセッションID: " . $realSessionId . "\n";

    // セッションIDを再度設定しようとしても、セッション開始後は無視される
    $anotherNewSessionId = 'anothernewsessionid456';
    session_id($anotherNewSessionId);
    $sessionIdAfterAttempt = session_id();
    echo "セッション開始後に設定を試みた後のセッションID: " . $sessionIdAfterAttempt . "\n";

    if ($realSessionId !== $sessionIdAfterAttempt){
        echo "セッション開始後のsession_id()は設定できないことを確認しました。\n";
    }
}

session_id_example();

PHPのsession_id()関数は、現在のセッションIDを取得または設定するために使用します。引数に$idを指定しない場合、現在のセッションIDを文字列で返します。セッションが開始されていない場合は空文字列を返します。セッションIDの取得に失敗した場合はfalseを返します。

引数$idに文字列を指定すると、セッションIDを新しい値に設定しようとします。ただし、セッションIDの設定はsession_start()関数を呼び出す前に行う必要があります。セッション開始後にsession_id()で新しいIDを設定しようとしても、その試みは無視されます。

サンプルコードでは、まずsession_id()で現在のセッションIDを取得し、セッションが開始されていない状態を確認しています。次に、session_id()に新しいIDを渡して設定を試み、設定後のセッションIDを確認します。その後、session_start()でセッションを開始し、再度session_id()を呼び出して実際のセッションIDが返ることを確認します。最後に、セッション開始後にsession_id()でIDを設定しようとしても無視されることを確認しています。この関数を使うことで、セッション管理をより柔軟に行うことができます。