public function DateFormatterInterface::formatTimeDiffUntil in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Datetime/DateFormatterInterface.php \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffUntil()
2. 10 core/lib/Drupal/Core/Datetime/DateFormatterInterface.php \Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffUntil()

Formats the time difference from the current request time to a timestamp.

Parameters

$timestamp: A UNIX timestamp to compare against the current request time.

array $options: (optional) An associative array with additional options. The following keys can be used:

• granularity: An integer value that signals how many different units to display in the string. Defaults to 2.
• langcode: The language code for the language used to format the date. Defaults to NULL, which results in the user interface language for the page being used.
• strict: A Boolean value indicating whether or not the timestamp can be before the current request time. If TRUE (default) and $timestamp is before the current request time, the result string will be "0 seconds". If FALSE and $timestamp is before the current request time, the result string will be the formatted time difference.
• return_as_object: A Boolean value whether to return a FormattedDateDiff object.

Return value

string|\Drupal\Core\Datetime\FormattedDateDiff A translated string representation of the difference between the given timestamp and the current request time. This interval is always positive.

See also

\Drupal\Core\Datetime\DateFormatterInterface::formatDiff()

\Drupal\Core\Datetime\DateFormatterInterface::formatTimeDiffSince()

1 method overrides DateFormatterInterface::formatTimeDiffUntil()

DateFormatter::formatTimeDiffUntil in core/lib/Drupal/Core/Datetime/DateFormatter.php

Formats the time difference from the current request time to a timestamp.

File

core/lib/Drupal/Core/Datetime/DateFormatterInterface.php, line 115

Class

DateFormatterInterface

Provides an interface defining a date formatter.

Namespace

Drupal\Core\Datetime

Code

public function formatTimeDiffUntil($timestamp, $options = []);