public function TestTime::getRequestTime in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/update/tests/modules/update_test/src/Datetime/TestTime.php \Drupal\update_test\Datetime\TestTime::getRequestTime()
2. 9 core/modules/update/tests/modules/update_test/src/Datetime/TestTime.php \Drupal\update_test\Datetime\TestTime::getRequestTime()

Returns the timestamp for the current request.

This method should be used to obtain the current system time at the start of the request. It will be the same value for the life of the request (even for long execution times).

If the request is not available it will fallback to the current system time.

This method can replace instances of

$request_time = $_SERVER['REQUEST_TIME'];
$request_time = REQUEST_TIME;
$request_time = $requestStack
  ->getCurrentRequest()->server
  ->get('REQUEST_TIME');
$request_time = $request->server
  ->get('REQUEST_TIME');

and most instances of

$time = time();

with

$request_time = \Drupal::time()
  ->getRequestTime();

or the equivalent using the injected service.

Using the time service, rather than other methods, is especially important when creating tests, which require predictable timestamps.

Return value

int A Unix timestamp.

Overrides Time::getRequestTime

See also

\Drupal\Component\Datetime\TimeInterface::getRequestMicroTime()

\Drupal\Component\Datetime\TimeInterface::getCurrentTime()

\Drupal\Component\Datetime\TimeInterface::getCurrentMicroTime()

File

core/modules/update/tests/modules/update_test/src/Datetime/TestTime.php, line 15

Class

TestTime

Test service for altering the request time.

Namespace

Drupal\update_test\Datetime

Code

public function getRequestTime() {
  if ($mock_date = \Drupal::state()
    ->get('update_test.mock_date', NULL)) {
    return \DateTime::createFromFormat('Y-m-d', $mock_date)
      ->getTimestamp();
  }
  return parent::getRequestTime();
}