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

<?php

// スクリプトの開始時刻を記録します。
$startTime = microtime(true);

echo "スクリプトの実行時間制限を無制限に設定します。\n";

// set_time_limit(0) は、スクリプトの実行時間制限を解除し、無制限にします。
// これにより、非常に長い時間かかる処理でも、途中でスクリプトが強制終了されることを防ぎます。
// 通常、PHPスクリプトのデフォルト実行時間制限は30秒です。
if (set_time_limit(0)) {
    echo "実行時間制限は正常に無制限に設定されました。\n";
} else {
    // set_time_limit()がfalseを返す場合、PHPのセーフモードなどの設定により制限変更ができない可能性があります。
    echo "警告: 実行時間制限の設定に失敗しました。(セーフモードなどにより制限されている可能性があります)\n";
    // この場合でも、スクリプトは設定された時間制限内で実行を続けます。
}

echo "長時間かかる処理をシミュレートします。60秒間待機します...\n";

// PHPのデフォルトの実行時間制限が30秒の場合でも、set_time_limit(0)が機能していれば
// この60秒間の待機は完了します。
sleep(60);

echo "60秒間の待機が完了しました。\n";

// スクリプトの終了時刻を記録し、総実行時間を計算します。
$endTime = microtime(true);
$executionTime = round($endTime - $startTime, 2);

echo "スクリプトの総実行時間: {$executionTime} 秒\n";

?>

PHPのset_time_limit関数は、スクリプトが実行できる最大時間を設定するために使用されます。引数$secondsには、スクリプトの実行を許可する秒数を整数で指定します。例えばset_time_limit(60)とすると、スクリプトは最大で60秒間実行できます。この関数は、設定が成功した場合はtrueを、失敗した場合はfalseを返します。

特に、引数に0を指定するset_time_limit(0)は、スクリプトの実行時間制限を解除し、無制限に設定することを意味します。PHPスクリプトのデフォルトの実行時間制限は通常30秒ですが、データ処理やファイルアップロードなど、非常に長い時間がかかる処理を行う場合に、この制限によってスクリプトが途中で強制終了されてしまうことがあります。

このサンプルコードでは、まずset_time_limit(0)を実行して実行時間制限を無制限にしています。その後にsleep(60)関数で60秒間の待機処理を行っていますが、デフォルトの30秒を超えてもスクリプトは正常に完了しています。これは、set_time_limit(0)が効果的に機能し、実行時間制限が解除されていることを示しています。これにより、時間のかかる処理も安心して実行できるようになります。

<?php

/**
 * set_time_limit() の使用方法と、初心者が「効かない」と感じる一般的な理由を説明するサンプルコード。
 *
 * set_time_limit() はスクリプトの実行時間制限を設定します。
 * ここで設定する時間はCPU処理時間に主に適用されます。
 *
 * @param int $seconds スクリプトの最大実行時間（秒）。0を指定すると制限なし。
 * @return void
 */
function demonstrateSetTimeLimit(int $seconds): void
{
    echo "現在の 'max_execution_time' (php.iniより): " . ini_get('max_execution_time') . " 秒\n";
    echo "スクリプトの実行時間制限を " . $seconds . " 秒に設定しようとしています。\n";

    // set_time_limit() はタイムアウトカウンターをゼロから再開します。
    //
    // set_time_limit() が「効かない」（意図した通りに動作しない）と感じられる主な理由:
    // 1. php.ini の 'max_execution_time' が低い: set_time_limit() は、php.ini
    //    で設定されている 'max_execution_time' の値を超えて制限を延長することはできません
    //    (php.ini の値が 0 (無制限) の場合を除く)。
    // 2. Webサーバーのタイムアウト: ApacheやNginxなどのWebサーバーには独自のタイムアウト設定があり、
    //    PHPの制限に達する前にスクリプトを終了させることがあります。
    //    set_time_limit() はこれらの外部タイムアウトを制御できません。
    // 3. I/O処理の時間: データベースクエリやネットワークリクエストなど、システムコールや
    //    外部リソースの待機に費やされた時間は、一般的にPHPの 'max_execution_time' には
    //    カウントされません (システムやPHPのSAPI設定により異なります)。
    //    そのため、スクリプトがI/O処理に多くの時間を費やす場合、set_time_limit() で設定した
    //    壁時計時間を超えてもPHPがスクリプトを終了させないことがあります。
    //
    // set_time_limit() が失敗した場合（例: 非常に古いPHPバージョンのセーフモード、権限の問題など）、
    // falseを返します。PHP 8.4では、通常はtrueを返します。
    $set_success = set_time_limit($seconds);

    if (!$set_success) {
        echo "警告: set_time_limit() の呼び出しに失敗しました。元の時間制限が有効なままです。\n";
        return;
    }

    echo "時間制限を " . $seconds . " 秒に設定しました。\n";
    echo "制限を超えるために、意図的に " . ($seconds + 1) . " 秒間の処理をシミュレートします。\n";
    $start_time = microtime(true);

    // CPU負荷の高い処理をシミュレートします。
    // このループは、設定された時間制限を超過するように設計されています。
    // set_time_limit() が正しく機能していれば、このループの完了前にスクリプトは終了するはずです。
    $target_duration_to_exceed_limit = $seconds + 1;
    while ((microtime(true) - $start_time) < $target_duration_to_exceed_limit) {
        // 時間を消費するためのダミー計算
        for ($i = 0; $i < 50000; $i++) {
            $dummy = sqrt($i * M_PI);
        }
    }

    $end_time = microtime(true);
    $elapsed_time = $end_time - $start_time;

    echo "処理が正常に完了しました。経過時間: " . round($elapsed_time, 2) . " 秒。\n";
    echo "このメッセージが表示された場合、スクリプトが制限時間内に完了したか、\n";
    echo "または時間制限が意図した通りに適用されなかった可能性があります。\n";
}

// --- 使用例 ---
// 2秒の実行時間制限を設定します。
// php.ini の max_execution_time がこの値より大きい（例: 30秒）場合、
// スクリプトは約2秒後に「Fatal error: Maximum execution time of ... seconds exceeded」
// というエラーメッセージで終了するはずです。
// もしエラーが発生せず、上記の「処理が正常に完了しました。」のメッセージが表示される場合、
// php.iniの設定、Webサーバーのタイムアウト、またはI/O待機時間などの外部要因により、
// set_time_limit() が意図した通りに機能していない可能性があります。
demonstrateSetTimeLimit(2);

// 必要に応じて、時間制限を無効にする例 (php.iniが許可している場合):
// demonstrateSetTimeLimit(0);

PHPのset_time_limit関数は、現在実行中のスクリプトが処理に使える最大実行時間を秒単位で設定するものです。引数$secondsには、スクリプトが継続して実行できる最大秒数を整数で指定します。もし0（ゼロ）を設定すると、時間制限が無効となり、スクリプトは時間制限なしで実行されます。この関数は、時間制限の設定が成功した場合にtrueを、何らかの理由で失敗した場合にfalseを返します。

しかし、初心者がset_time_limitが「効かない」と感じる一般的な理由がいくつか存在します。一つは、PHPの設定ファイルphp.iniにあるmax_execution_timeの値が、スクリプトの実行時間の上限となるため、set_time_limitではこの上限を超えて時間を延長できない点です（php.iniのmax_execution_timeが0で無制限に設定されている場合を除きます）。また、ApacheやNginxなどのWebサーバーには独自のタイムアウト設定があり、PHPの制限よりも早くスクリプトを終了させることがあります。さらに、データベースへの問い合わせやネットワーク通信といった外部リソースの待機（I/O処理）に費やされた時間は、PHPの実行時間制限にはカウントされないことが多く、スクリプトがI/O処理で長く停止してもPHPの制限に達しない場合があります。

このサンプルコードは、これらの特性を考慮し、設定した時間制限を超過するCPU負荷の高い処理を意図的に実行することで、set_time_limitの実際の挙動を検証しています。万が一、意図した通りに制限が適用されない場合は、php.iniやWebサーバーの設定が原因である可能性が高いことを示唆しています。