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

<?php

/**
 * session_cache_expire 関数の使用例
 *
 * このスクリプトは、PHPセッションのクライアント側キャッシュ有効期限
 * (通常はブラウザがセッションページをキャッシュする期間) の取得と設定方法を示します。
 */

// セッションを開始します。これは、セッション関連の関数を使用する前に必須です。
// セッションIDがまだ存在しない場合は新しく生成され、存在する場合は既存のセッションを復元します。
session_start();

echo "<h3>PHP session_cache_expire の使用例</h3>";

// 1. 現在のセッションキャッシュ有効期限を取得します。
// 引数を指定しない場合、現在の有効期限が分単位で返されます。
$currentCacheExpire = session_cache_expire();

if ($currentCacheExpire === false) {
    echo "<p>エラー: 現在のキャッシュ有効期限を取得できませんでした。</p>";
} else {
    echo "<p>現在のセッションキャッシュ有効期限: " . $currentCacheExpire . " 分</p>";
}

// 2. 新しいセッションキャッシュ有効期限を設定します。
// ここでは 30 分に設定します。この関数は、設定前の古い値を返します。
// 例えば、以前が 180 分だった場合、この関数は 180 を返し、新しい設定は 30 分になります。
$oldCacheExpire = session_cache_expire(30); // 30 分に設定

if ($oldCacheExpire === false) {
    echo "<p>エラー: 新しいキャッシュ有効期限を設定できませんでした。</p>";
} else {
    echo "<p>新しいキャッシュ有効期限設定前の値: " . $oldCacheExpire . " 分</p>";
}

// 3. 設定が正しく変更されたことを確認するため、再度現在の有効期限を取得します。
$newCurrentCacheExpire = session_cache_expire();

if ($newCurrentCacheExpire === false) {
    echo "<p>エラー: 設定後のキャッシュ有効期限を取得できませんでした。</p>";
} else {
    echo "<p>新しいセッションキャッシュ有効期限: " . $newCurrentCacheExpire . " 分</p>";
}

// 注意: session_cache_expire は、PHPのsession.cache_expireディレクティブを設定します。
// これは、HTTPヘッダー (Cache-Control: max-age=...) を通じてブラウザに送信され、
// セッションページのクライアント側キャッシュ動作に影響を与えます。

?>

PHPのsession_cache_expire関数は、セッションページのクライアント側キャッシュ有効期限、つまりブラウザがセッションページを記憶する期間を取得・設定するために使用されます。この関数を使う前に、session_start()関数でセッションを必ず開始してください。

引数を指定せずにsession_cache_expire()を呼び出すと、現在のキャッシュ有効期限が分単位の整数で返されます。取得に失敗した場合はfalseが戻り値となります。

一方、引数に?int $new_cache_expireとして新しい有効期限を分単位の整数で指定すると、その値が設定され、設定前の古いキャッシュ有効期限が分単位の整数で返されます。設定が失敗した場合もfalseが戻り値となります。

この設定は、HTTPヘッダーを通じてブラウザに伝えられ、ブラウザがセッションページをクライアント側でキャッシュする動作に影響を与えます。

<?php

/**
 * セッションキャッシュ有効期限の取得と設定を行うサンプルコード
 *
 * session_cache_expire() 関数は、現在のセッションキャッシュ有効期限（分）を取得したり、
 * 新しい有効期限を設定したりするために使用されます。
 * この設定は、PHPの 'session.cache_expire' 設定を上書きします。
 *
 * システムエンジニアを目指す初心者向けに、セッション管理の基本と
 * キャッシュ設定の変更方法を理解しやすく構成しています。
 */

// セッションを開始または既存のセッションを再開します。
// session_start() は、セッション関数を使用する前に必ず呼び出す必要があります。
// 既にセッションが開始されていないか確認する事で、複数回の呼び出しによる警告を防ぎます。
if (session_status() === PHP_SESSION_NONE) {
    session_start();
}

echo "<h2>セッションキャッシュ有効期限の管理</h2>";

// 1. 現在のセッションキャッシュ有効期限（分）を取得する
// 引数を渡さない場合、現在の設定値が返されます。
$currentCacheExpire = session_cache_expire();

if ($currentCacheExpire === false) {
    echo "<p>エラー: 現在のセッションキャッシュ有効期限の取得に失敗しました。</p>";
} else {
    echo "<p>現在のセッションキャッシュ有効期限: <strong>{$currentCacheExpire} 分</strong></p>";
}

// 2. 新しいセッションキャッシュ有効期限を45分に設定する
// 引数に整数を渡すと、新しい有効期限が設定されます。
// この関数は、設定前の有効期限を返します。
$oldCacheExpire = session_cache_expire(45);

if ($oldCacheExpire === false) {
    echo "<p>エラー: セッションキャッシュ有効期限の設定に失敗しました。</p>";
} else {
    echo "<p>設定前のセッションキャッシュ有効期限: <strong>{$oldCacheExpire} 分</strong> (新しい値: 45分に設定)</p>";
}

// 3. 設定後のセッションキャッシュ有効期限を再度取得して確認する
$newCacheExpire = session_cache_expire();

if ($newCacheExpire === false) {
    echo "<p>エラー: 設定後のセッションキャッシュ有効期限の取得に失敗しました。</p>";
} else {
    echo "<p>設定後のセッションキャッシュ有効期限: <strong>{$newCacheExpire} 分</strong></p>";
}

// 注意: この設定は、現在のスクリプト実行中にのみ有効です。
// 通常、WebサーバーはPHP設定（php.ini）やWebサーバー設定（.htaccessなど）で
// セッションキャッシュの有効期限が定義されています。

?>

PHPの session_cache_expire 関数は、ウェブアプリケーションでユーザーのセッション情報を管理する際に使用される、セッションキャッシュの有効期限を設定および取得するための関数です。この関数を利用することで、セッションデータがサーバー上にどのくらいの期間保持されるかを分単位で制御できます。

引数 $new_cache_expire はオプションで、整数値を指定すると、セッションキャッシュの新しい有効期限を分単位で設定します。この際、関数は設定を行う前の有効期限を整数値で返します。引数を省略したり null を渡したりした場合は、現在の有効期限がそのまま取得され、設定は変更されません。

戻り値は、処理が成功した場合は整数値（有効期限の分単位）を返します。何らかの理由で操作に失敗した場合は false を返します。

サンプルコードでは、まず session_start() でセッションを開始した後、引数なしで session_cache_expire() を呼び出して現在の有効期限を取得し、表示しています。次に、session_cache_expire(45) のように引数に 45 を渡すことで、有効期限を45分に設定し、設定前の値を確認しています。最後に再度引数なしで関数を呼び出し、新しい設定が適用されていることを確認しています。この関数による設定は、PHPの設定ファイル php.ini で定義されている session.cache_expire の値を上書きしますが、その効果は現在のスクリプト実行中に限定されます。