public static function Environment::setTimeLimit in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Component/Utility/Environment.php \Drupal\Component\Utility\Environment::setTimeLimit()

Attempts to set the PHP maximum execution time.

This function is a wrapper around the PHP function set_time_limit(). When called, set_time_limit() restarts the timeout counter from zero. In other words, if the timeout is the default 30 seconds, and 25 seconds into script execution a call such as set_time_limit(20) is made, the script will run for a total of 45 seconds before timing out.

If the current time limit is not unlimited it is possible to decrease the total time limit if the sum of the new time limit and the current time spent running the script is inferior to the original time limit. It is inherent to the way set_time_limit() works, it should rather be called with an appropriate value every time you need to allocate a certain amount of time to execute a task than only once at the beginning of the script.

Before calling set_time_limit(), we check if this function is available because it could be disabled by the server administrator.

Parameters

int $time_limit: An integer time limit in seconds, or 0 for unlimited execution time.

Return value

bool Whether set_time_limit() was successful or not.

3 calls to Environment::setTimeLimit()

Cron::run in core/lib/Drupal/Core/Cron.php

Executes a cron run.

FunctionalTestSetupTrait::prepareEnvironment in core/lib/Drupal/Core/Test/FunctionalTestSetupTrait.php

Prepares the current environment for running the test.

node_access_rebuild in core/modules/node/node.module

Rebuilds the node access database.

File

core/lib/Drupal/Component/Utility/Environment.php, line 65

Class

Environment

Provides PHP environment helper methods.

Namespace

Drupal\Component\Utility

Code

public static function setTimeLimit($time_limit) {
  if (function_exists('set_time_limit')) {
    $current = ini_get('max_execution_time');

    // Do not set time limit if it is currently unlimited.
    if ($current != 0) {
      return set_time_limit($time_limit);
    }
  }
  return FALSE;
}