public function Time::getRequestMicroTime in Drupal 10

Same name and namespace in other branches

8 core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time::getRequestMicroTime()
9 core/lib/Drupal/Component/Datetime/Time.php \Drupal\Component\Datetime\Time::getRequestMicroTime()

Returns the timestamp for the current request with microsecond precision.

This method should be used to obtain the current system time, with microsecond precision, 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 with microsecond precision.

This method can replace instances of

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

and many instances of

$microtime = microtime();
$microtime = microtime(TRUE);

with

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

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

float A Unix timestamp with a fractional portion.

Overrides TimeInterface::getRequestMicroTime

File

core/lib/Drupal/Component/Datetime/Time.php, line 45

Class

Time: Provides a class for obtaining system time.

Namespace

Drupal\Component\Datetime

Code

public function getRequestMicroTime() {
  $request = $this->requestStack
    ->getCurrentRequest();
  if ($request) {
    return $request->server
      ->get('REQUEST_TIME_FLOAT');
  }

  // If this is called prior to the request being pushed to the stack fallback
  // to built-in globals (if available) or the system time.
  return $_SERVER['REQUEST_TIME_FLOAT'] ?? $this
    ->getCurrentMicroTime();
}

You are here