class FormattedDateDiff

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Datetime/FormattedDateDiff.php \Drupal\Core\Datetime\FormattedDateDiff
  2. 10 core/lib/Drupal/Core/Datetime/FormattedDateDiff.php \Drupal\Core\Datetime\FormattedDateDiff
  3. 9 core/lib/Drupal/Core/Datetime/FormattedDateDiff.php \Drupal\Core\Datetime\FormattedDateDiff
  4. 8.9.x core/lib/Drupal/Core/Datetime/FormattedDateDiff.php \Drupal\Core\Datetime\FormattedDateDiff

Contains a formatted time difference.

Hierarchy

Expanded class hierarchy of FormattedDateDiff

1 file declares its use of FormattedDateDiff
DateTest.php in core/tests/Drupal/Tests/Core/Datetime/DateTest.php

File

core/lib/Drupal/Core/Datetime/FormattedDateDiff.php, line 12

Namespace

Drupal\Core\Datetime
View source
class FormattedDateDiff implements RenderableInterface, CacheableDependencyInterface {
  use UnchangingCacheableDependencyTrait;
  
  /**
   * Creates a new FormattedDateDiff instance.
   *
   * @param string $string
   *   The formatted time difference.
   * @param int $maxAge
   *   The maximum time in seconds that this string may be cached.
   */
  public function __construct(protected $string, protected $maxAge) {
  }
  
  /**
   * @return string
   *   The actual formatted time difference.
   */
  public function getString() {
    return $this->string;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    return $this->maxAge;
  }
  
  /**
   * {@inheritdoc}
   */
  public function toRenderable() {
    return [
      '#markup' => $this->string,
      '#cache' => [
        'max-age' => $this->maxAge,
      ],
    ];
  }

}

Members


Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.