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

<?php

/**
 * ini_restore 関数の使用例を示します。
 * スクリプトの実行時設定を一時的に変更し、その後元の値に戻す方法を理解するのに役立ちます。
 */
function demonstrateIniRestore(): void
{
    echo "=== ini_restore 関数デモンストレーション ===\n\n";

    $optionName = 'max_execution_time'; // 例として実行時間設定を使用

    // 1. 現在の 'max_execution_time' の値を取得して表示します。
    $originalValue = ini_get($optionName);
    echo "変更前の '{$optionName}' の値: " . $originalValue . " 秒\n";

    // 2. 'max_execution_time' を一時的に変更します。
    // 例えば、このスクリプトブロック内で長時間かかる処理を行うために、実行時間を長く設定します。
    $newValue = 60; // 60秒に設定
    echo "一時的に '{$optionName}' を {$newValue} 秒に設定します...\n";
    ini_set($optionName, (string)$newValue);

    // 3. 変更後の値を確認します。
    $currentValue = ini_get($optionName);
    echo "変更後の '{$optionName}' の値: " . $currentValue . " 秒\n";

    // ここで、変更された設定値が適用される何らかの処理を実行します。
    // 例: sleep(5); // 実際に5秒間待機する処理など

    // 4. ini_restore を使って 'max_execution_time' を元の値に戻します。
    echo "ini_restore を使って '{$optionName}' を元の値に戻します...\n";
    ini_restore($optionName);

    // 5. 復元後の値を確認します。
    $restoredValue = ini_get($optionName);
    echo "復元後の '{$optionName}' の値: " . $restoredValue . " 秒\n";

    echo "\n=== デモンストレーション終了 ===\n";
}

// 関数を実行します。
demonstrateIniRestore();

?>

PHP 8のini_restore関数は、スクリプトの実行中にini_set関数によって一時的に変更されたPHPの設定値を、そのスクリプトが実行される前の元の状態に戻すために使用されます。特定の処理のために一時的に設定を変更した後、他の処理に影響を与えないよう元の設定に戻すことが可能です。

引数$optionには、元の値に戻したい設定項目名を文字列で指定します。例えば、'max_execution_time'のように指定します。この関数はvoidを返すため、戻り値はありません。

提供されたサンプルコードでは、max_execution_time（スクリプトの最大実行時間）を例に挙げています。まずini_getで現在の設定値を確認し、その後ini_setを使って一時的に値を変更します。一時的な変更が行われた後、ini_restoreに'max_execution_time'を渡すことで、設定値がスクリプト実行前の元の値に正確に戻されていることをini_getで再確認しています。このように、ini_restoreは一時的な設定変更を安全に元に戻し、スクリプト全体の挙動を予測可能な状態に保つ上で重要な役割を果たします。

<?php

/**
 * PHPのini_restore関数の使用例を示します。
 * 指定されたPHP設定オプションの値を一時的に変更し、その後PHPの起動時のデフォルト値に戻します。
 *
 * @return void
 */
function demonstrateIniRestoreOption(): void
{
    // ここで操作するPHP設定オプションを指定します。
    // 'max_execution_time' はスクリプトの最大実行時間を秒単位で設定します。
    // これは `ini_restore` の動作を示すのに適したオプションです。
    $option = 'max_execution_time';

    echo "--- ini_restore 関数デモンストレーション ---" . PHP_EOL;

    // 1. 設定変更前の現在のINI設定値を取得して表示します。
    $initialValue = ini_get($option);
    echo "1. 初期値 ({$option}): " . ($initialValue === false ? '取得失敗' : "{$initialValue} 秒") . PHP_EOL;

    // 2. ini_set関数を使って、INI設定値を一時的に変更します。
    // ここでは最大実行時間を5秒に設定しています。
    $newValue = 5;
    if (ini_set($option, (string)$newValue) !== false) {
        echo "2. 設定変更 ({$option}を{$newValue}秒に): " . ini_get($option) . " 秒" . PHP_EOL;
    } else {
        echo "2. 設定変更に失敗しました。このオプションは変更できない可能性があります。" . PHP_EOL;
    }

    // 3. ini_restore関数を使って、INI設定値をPHP起動時のデフォルト値に戻します。
    ini_restore($option);
    echo "3. デフォルト値に復元 ({$option}): " . ini_get($option) . " 秒" . PHP_EOL;

    echo "--- デモンストレーション終了 ---" . PHP_EOL;

    // 補足:
    // PHP起動時のデフォルト値は、php.iniファイル、Webサーバーの設定、
    // またはSAPI（サーバーAPI）によって定義されます。
    // 一般的な 'max_execution_time' のデフォルト値は30秒です。
}

// 関数を実行して、ini_restore の動作を確認します。
demonstrateIniRestoreOption();

PHP 8のini_restore関数は、指定したPHP設定オプションの値を、PHPが起動したときのデフォルト値に戻すために使用されます。この関数は、ini_set関数などでスクリプト実行中に一時的に変更された設定を、元の状態に戻したい場合に役立ちます。

引数 $option には、デフォルト値に戻したいPHP設定オプションの名前を文字列で指定します。例えば、'max_execution_time'のように指定します。戻り値は void であり、処理の成功・失敗を示す特定の値を返しませんが、指定されたオプションは確実にデフォルト値に戻されます。

提供されたサンプルコードでは、スクリプトの最大実行時間を制御する 'max_execution_time' オプションを例に、ini_restore関数の動作を示しています。コードはまず、ini_get関数で現在の設定値を確認し、次にini_set関数で一時的に値を変更（例えば5秒に設定）します。その後、ini_restore($option)を実行することで、max_execution_timeの設定値がPHP起動時のデフォルト値（多くの場合30秒）に復元される様子が確認できます。このように、プログラムの実行中に特定の処理のために一時的に設定を変更し、その後元の安定した状態に戻したい場合に、ini_restore関数は非常に便利です。