public function DateFormatterTest::testFormat in Drupal 9

Same name and namespace in other branches

1. 8 core/tests/Drupal/KernelTests/Core/Datetime/DateFormatterTest.php \Drupal\KernelTests\Core\Datetime\DateFormatterTest::testFormat()

Tests DateFormatter::format().

@covers ::format

File

core/tests/Drupal/KernelTests/Core/Datetime/DateFormatterTest.php, line 54

Class

DateFormatterTest

Tests date formatting.

Namespace

Drupal\KernelTests\Core\Datetime

Code

public function testFormat() {

  /** @var \Drupal\Core\Datetime\DateFormatterInterface $formatter */
  $formatter = $this->container
    ->get('date.formatter');

  /** @var \Drupal\Core\Language\LanguageManagerInterface $language_manager */
  $language_manager = $this->container
    ->get('language_manager');
  $timestamp = strtotime('2007-03-26T00:00:00+00:00');
  $this
    ->assertSame('Sunday, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T', 'America/Los_Angeles', 'en'), 'Test all parameters.');
  $this
    ->assertSame('domingo, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T', 'America/Los_Angeles', self::LANGCODE), 'Test translated format.');
  $this
    ->assertSame('l, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', '\\l, d-M-y H:i:s T', 'America/Los_Angeles', self::LANGCODE), 'Test an escaped format string.');
  $this
    ->assertSame('\\domingo, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', '\\\\l, d-M-y H:i:s T', 'America/Los_Angeles', self::LANGCODE), 'Test format containing backslash character.');
  $this
    ->assertSame('\\l, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', '\\\\\\l, d-M-y H:i:s T', 'America/Los_Angeles', self::LANGCODE), 'Test format containing backslash followed by escaped format string.');
  $this
    ->assertSame('Monday, 26-Mar-07 01:00:00 BST', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T', 'Europe/London', 'en'), 'Test a different time zone.');
  $this
    ->assertSame('Thu, 01/01/1970 - 00:00', $formatter
    ->format(0, 'custom', '', 'UTC', 'en'), 'Test custom format with empty string.');

  // Make sure we didn't change the configuration override language.
  $this
    ->assertSame('en', $language_manager
    ->getConfigOverrideLanguage()
    ->getId(), 'Configuration override language not disturbed,');

  // Test bad format string will use the fallback format.
  $this
    ->assertSame($formatter
    ->format($timestamp, 'fallback'), $formatter
    ->format($timestamp, 'bad_format_string'), 'Test fallback format.');
  $this
    ->assertSame('en', $language_manager
    ->getConfigOverrideLanguage()
    ->getId(), 'Configuration override language not disturbed,');

  // Change the default language and timezone.
  $this
    ->config('system.site')
    ->set('default_langcode', static::LANGCODE)
    ->save();
  date_default_timezone_set('America/Los_Angeles');

  // Reset the language manager so new negotiations attempts will fall back on
  // on the new language.
  $language_manager
    ->reset();
  $this
    ->assertSame('en', $language_manager
    ->getConfigOverrideLanguage()
    ->getId(), 'Configuration override language not disturbed,');
  $this
    ->assertSame('Sunday, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T', 'America/Los_Angeles', 'en'), 'Test a different language.');
  $this
    ->assertSame('Monday, 26-Mar-07 01:00:00 BST', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T', 'Europe/London'), 'Test a different time zone.');
  $this
    ->assertSame('domingo, 25-Mar-07 17:00:00 PDT', $formatter
    ->format($timestamp, 'custom', 'l, d-M-y H:i:s T'), 'Test custom date format.');
  $this
    ->assertSame('domingo, 25. marzo 2007 - 17:00', $formatter
    ->format($timestamp, 'long'), 'Test long date format.');
  $this
    ->assertSame('25. marzo 2007 - 17:00', $formatter
    ->format($timestamp, 'medium'), 'Test medium date format.');
  $this
    ->assertSame('2007 Mar 25 - 5:00pm', $formatter
    ->format($timestamp, 'short'), 'Test short date format.');
  $this
    ->assertSame('25. marzo 2007 - 17:00', $formatter
    ->format($timestamp), 'Test default date format.');

  // Test HTML time element formats.
  $this
    ->assertSame('2007-03-25T17:00:00-0700', $formatter
    ->format($timestamp, 'html_datetime'), 'Test html_datetime date format.');
  $this
    ->assertSame('2007-03-25', $formatter
    ->format($timestamp, 'html_date'), 'Test html_date date format.');
  $this
    ->assertSame('17:00:00', $formatter
    ->format($timestamp, 'html_time'), 'Test html_time date format.');
  $this
    ->assertSame('03-25', $formatter
    ->format($timestamp, 'html_yearless_date'), 'Test html_yearless_date date format.');
  $this
    ->assertSame('2007-W12', $formatter
    ->format($timestamp, 'html_week'), 'Test html_week date format.');
  $this
    ->assertSame('2007-03', $formatter
    ->format($timestamp, 'html_month'), 'Test html_month date format.');
  $this
    ->assertSame('2007', $formatter
    ->format($timestamp, 'html_year'), 'Test html_year date format.');

  // Make sure we didn't change the configuration override language.
  $this
    ->assertSame('en', $language_manager
    ->getConfigOverrideLanguage()
    ->getId(), 'Configuration override language not disturbed,');

  // Test bad format string will use the fallback format.
  $this
    ->assertSame($formatter
    ->format($timestamp, 'fallback'), $formatter
    ->format($timestamp, 'bad_format_string'), 'Test fallback format.');
  $this
    ->assertSame('en', $language_manager
    ->getConfigOverrideLanguage()
    ->getId(), 'Configuration override language not disturbed,');

  // HTML is not escaped by the date formatter, it must be escaped later.
  $this
    ->assertSame("<script>alert('2007');</script>", $formatter
    ->format($timestamp, 'custom', '\\<\\s\\c\\r\\i\\p\\t\\>\\a\\l\\e\\r\\t\\(\'Y\'\\)\\;\\<\\/\\s\\c\\r\\i\\p\\t\\>'), 'Script tags not removed from dates.');
  $this
    ->assertSame('<em>2007</em>', $formatter
    ->format($timestamp, 'custom', '\\<\\e\\m\\>Y\\<\\/\\e\\m\\>'), 'Em tags are not removed from dates.');
}