3 namespace Drupal\KernelTests\Core\Datetime;
5 use Drupal\KernelTests\KernelTestBase;
6 use Drupal\language\Entity\ConfigurableLanguage;
9 * Tests date formatting.
13 class FormatDateTest extends KernelTestBase {
18 public static $modules = ['language', 'system'];
21 * Arbitrary langcode for a custom language.
23 const LANGCODE = 'xx';
28 protected function setUp() {
31 $this->installConfig(['system']);
33 $this->setSetting('locale_custom_strings_' . self::LANGCODE, [
34 '' => ['Sunday' => 'domingo'],
35 'Long month name' => ['March' => 'marzo'],
38 $formats = $this->container->get('entity.manager')
39 ->getStorage('date_format')
40 ->loadMultiple(['long', 'medium', 'short']);
41 $formats['long']->setPattern('l, j. F Y - G:i')->save();
42 $formats['medium']->setPattern('j. F Y - G:i')->save();
43 $formats['short']->setPattern('Y M j - g:ia')->save();
45 ConfigurableLanguage::createFromLangcode(static::LANGCODE)->save();
49 * Tests the format_date() function.
51 public function testFormatDate() {
52 /** @var \Drupal\Core\Datetime\DateFormatterInterface $formatter */
53 $formatter = $this->container->get('date.formatter');
54 /** @var \Drupal\Core\Language\LanguageManagerInterface $language_manager */
55 $language_manager = $this->container->get('language_manager');
57 $timestamp = strtotime('2007-03-26T00:00:00+00:00');
58 $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.');
59 $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.');
60 $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.');
61 $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.');
62 $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.');
63 $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.');
64 $this->assertSame('Thu, 01/01/1970 - 00:00', $formatter->format(0, 'custom', '', 'UTC', 'en'), 'Test custom format with empty string.');
66 // Make sure we didn't change the configuration override language.
67 $this->assertSame('en', $language_manager->getConfigOverrideLanguage()->getId(), 'Configuration override language not disturbed,');
69 // Test bad format string will use the fallback format.
70 $this->assertSame($formatter->format($timestamp, 'fallback'), $formatter->format($timestamp, 'bad_format_string'), 'Test fallback format.');
71 $this->assertSame('en', $language_manager->getConfigOverrideLanguage()->getId(), 'Configuration override language not disturbed,');
73 // Change the default language and timezone.
74 $this->config('system.site')->set('default_langcode', static::LANGCODE)->save();
75 date_default_timezone_set('America/Los_Angeles');
77 // Reset the language manager so new negotiations attempts will fall back on
78 // on the new language.
79 $language_manager->reset();
80 $this->assertSame('en', $language_manager->getConfigOverrideLanguage()->getId(), 'Configuration override language not disturbed,');
82 $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.');
83 $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.');
84 $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.');
85 $this->assertSame('domingo, 25. marzo 2007 - 17:00', $formatter->format($timestamp, 'long'), 'Test long date format.');
86 $this->assertSame('25. marzo 2007 - 17:00', $formatter->format($timestamp, 'medium'), 'Test medium date format.');
87 $this->assertSame('2007 Mar 25 - 5:00pm', $formatter->format($timestamp, 'short'), 'Test short date format.');
88 $this->assertSame('25. marzo 2007 - 17:00', $formatter->format($timestamp), 'Test default date format.');
89 // Test HTML time element formats.
90 $this->assertSame('2007-03-25T17:00:00-0700', $formatter->format($timestamp, 'html_datetime'), 'Test html_datetime date format.');
91 $this->assertSame('2007-03-25', $formatter->format($timestamp, 'html_date'), 'Test html_date date format.');
92 $this->assertSame('17:00:00', $formatter->format($timestamp, 'html_time'), 'Test html_time date format.');
93 $this->assertSame('03-25', $formatter->format($timestamp, 'html_yearless_date'), 'Test html_yearless_date date format.');
94 $this->assertSame('2007-W12', $formatter->format($timestamp, 'html_week'), 'Test html_week date format.');
95 $this->assertSame('2007-03', $formatter->format($timestamp, 'html_month'), 'Test html_month date format.');
96 $this->assertSame('2007', $formatter->format($timestamp, 'html_year'), 'Test html_year date format.');
98 // Make sure we didn't change the configuration override language.
99 $this->assertSame('en', $language_manager->getConfigOverrideLanguage()->getId(), 'Configuration override language not disturbed,');
101 // Test bad format string will use the fallback format.
102 $this->assertSame($formatter->format($timestamp, 'fallback'), $formatter->format($timestamp, 'bad_format_string'), 'Test fallback format.');
103 $this->assertSame('en', $language_manager->getConfigOverrideLanguage()->getId(), 'Configuration override language not disturbed,');
105 // HTML is not escaped by the date formatter, it must be escaped later.
106 $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.');
107 $this->assertSame('<em>2007</em>', $formatter->format($timestamp, 'custom', '\<\e\m\>Y\<\/\e\m\>'), 'Em tags are not removed from dates.');