class DrupalDateTimeTest
Same name in this branch
- 11.x core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php \Drupal\Tests\system\Functional\Datetime\DrupalDateTimeTest
Same name in other branches
- 9 core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php \Drupal\Tests\system\Functional\Datetime\DrupalDateTimeTest
- 9 core/tests/Drupal/Tests/Core/Datetime/DrupalDateTimeTest.php \Drupal\Tests\Core\Datetime\DrupalDateTimeTest
- 8.9.x core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php \Drupal\Tests\system\Functional\Datetime\DrupalDateTimeTest
- 8.9.x core/tests/Drupal/Tests/Core/Datetime/DrupalDateTimeTest.php \Drupal\Tests\Core\Datetime\DrupalDateTimeTest
- 10 core/modules/system/tests/src/Functional/Datetime/DrupalDateTimeTest.php \Drupal\Tests\system\Functional\Datetime\DrupalDateTimeTest
- 10 core/tests/Drupal/Tests/Core/Datetime/DrupalDateTimeTest.php \Drupal\Tests\Core\Datetime\DrupalDateTimeTest
@coversDefaultClass \Drupal\Core\Datetime\DrupalDateTime @group Datetime
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Datetime\DrupalDateTimeTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of DrupalDateTimeTest
File
-
core/
tests/ Drupal/ Tests/ Core/ Datetime/ DrupalDateTimeTest.php, line 17
Namespace
Drupal\Tests\Core\DatetimeView source
class DrupalDateTimeTest extends UnitTestCase {
/**
* Tests date diffs.
*
* @param mixed $input1
* A DrupalDateTime object.
* @param mixed $input2
* Date argument for DrupalDateTime::diff method.
* @param bool $absolute
* Absolute flag for DrupalDateTime::diff method.
* @param \DateInterval $expected
* The expected result of the DrupalDateTime::diff operation.
*
* @dataProvider providerTestDateDiff
*/
public function testDateDiff($input1, $input2, $absolute, \DateInterval $expected) : void {
$interval = $input1->diff($input2, $absolute);
$this->assertEquals($interval, $expected);
}
/**
* Tests date diff exception caused by invalid input.
*
* @param mixed $input1
* A DateTimePlus object.
* @param mixed $input2
* Date argument for DateTimePlus::diff method.
* @param bool $absolute
* Absolute flag for DateTimePlus::diff method.
*
* @dataProvider providerTestInvalidDateDiff
*/
public function testInvalidDateDiff($input1, $input2, $absolute) : void {
$this->expectException(\BadMethodCallException::class);
$this->expectExceptionMessage('Method Drupal\\Component\\Datetime\\DateTimePlus::diff expects parameter 1 to be a \\DateTime or \\Drupal\\Component\\Datetime\\DateTimePlus object');
$interval = $input1->diff($input2, $absolute);
}
/**
* Provides data for date tests.
*
* @return array
* An array of arrays, each containing the input parameters for
* DrupalDateTimeTest::testDateDiff().
*
* @see DrupalDateTimeTest::testDateDiff()
*/
public static function providerTestDateDiff() {
$settings = [
'langcode' => 'en',
];
$utc_tz = new \DateTimeZone('UTC');
$empty_interval = new \DateInterval('PT0S');
$positive_19_hours = new \DateInterval('PT19H');
$positive_18_hours = new \DateInterval('PT18H');
$positive_1_hour = new \DateInterval('PT1H');
$negative_1_hour = new \DateInterval('PT1H');
$negative_1_hour->invert = 1;
return [
// There should be a 19 hour time interval between
// new years in Sydney and new years in LA in year 2000.
[
'input2' => DrupalDateTime::createFromFormat('Y-m-d H:i:s', '2000-01-01 00:00:00', new \DateTimeZone('Australia/Sydney'), $settings),
'input1' => DrupalDateTime::createFromFormat('Y-m-d H:i:s', '2000-01-01 00:00:00', new \DateTimeZone('America/Los_Angeles'), $settings),
'absolute' => FALSE,
'expected' => $positive_19_hours,
],
// In 1970 Sydney did not observe daylight savings time
// So there is only an 18 hour time interval.
[
'input2' => DrupalDateTime::createFromFormat('Y-m-d H:i:s', '1970-01-01 00:00:00', new \DateTimeZone('Australia/Sydney'), $settings),
'input1' => DrupalDateTime::createFromFormat('Y-m-d H:i:s', '1970-01-01 00:00:00', new \DateTimeZone('America/Los_Angeles'), $settings),
'absolute' => FALSE,
'expected' => $positive_18_hours,
],
[
'input1' => DrupalDateTime::createFromFormat('U', '3600', new \DateTimeZone('America/Los_Angeles'), $settings),
'input2' => DrupalDateTime::createFromTimestamp(0, $utc_tz, $settings),
'absolute' => FALSE,
'expected' => $negative_1_hour,
],
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => DrupalDateTime::createFromTimestamp(0, $utc_tz, $settings),
'absolute' => FALSE,
'expected' => $negative_1_hour,
],
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => \DateTime::createFromFormat('U', '0'),
'absolute' => FALSE,
'expected' => $negative_1_hour,
],
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => DrupalDateTime::createFromTimestamp(0, $utc_tz, $settings),
'absolute' => TRUE,
'expected' => $positive_1_hour,
],
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => \DateTime::createFromFormat('U', '0'),
'absolute' => TRUE,
'expected' => $positive_1_hour,
],
[
'input1' => DrupalDateTime::createFromTimestamp(0, $utc_tz, $settings),
'input2' => DrupalDateTime::createFromTimestamp(0, $utc_tz, $settings),
'absolute' => FALSE,
'expected' => $empty_interval,
],
];
}
/**
* Provides data for date tests.
*
* @return array
* An array of arrays, each containing the input parameters for
* DateTimePlusTest::testInvalidDateDiff().
*
* @see DateTimePlusTest::testInvalidDateDiff()
*/
public static function providerTestInvalidDateDiff() {
$settings = [
'langcode' => 'en',
];
$utc_tz = new \DateTimeZone('UTC');
return [
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => '1970-01-01 00:00:00',
'absolute' => FALSE,
],
[
'input1' => DrupalDateTime::createFromTimestamp(3600, $utc_tz, $settings),
'input2' => NULL,
'absolute' => FALSE,
],
];
}
/**
* Tests setting the default time for date-only objects.
*/
public function testDefaultDateTime() : void {
$utc = new \DateTimeZone('UTC');
$date = DrupalDateTime::createFromFormat('Y-m-d H:i:s', '2017-05-23 22:58:00', $utc, [
'langcode' => 'en',
]);
$this->assertEquals('22:58:00', $date->format('H:i:s'));
$date->setDefaultDateTime();
$this->assertEquals('12:00:00', $date->format('H:i:s'));
}
/**
* Tests that object methods are chainable.
*
* @covers ::__call
*/
public function testChainable() : void {
$tz = new \DateTimeZone(date_default_timezone_get());
$date = new DrupalDateTime('now', $tz, [
'langcode' => 'en',
]);
$date->setTimestamp(12345678);
$rendered = $date->render();
$this->assertEquals('1970-05-24 07:21:18 Australia/Sydney', $rendered);
$date->setTimestamp(23456789);
$rendered = $date->setTimezone(new \DateTimeZone('America/New_York'))
->render();
$this->assertEquals('1970-09-29 07:46:29 America/New_York', $rendered);
}
/**
* Tests that non-chainable methods work.
*
* @covers ::__call
*/
public function testChainableNonChainable() : void {
$tz = new \DateTimeZone(date_default_timezone_get());
$datetime1 = new DrupalDateTime('2009-10-11 12:00:00', $tz, [
'langcode' => 'en',
]);
$datetime2 = new DrupalDateTime('2009-10-13 12:00:00', $tz, [
'langcode' => 'en',
]);
$interval = $datetime1->diff($datetime2);
$this->assertInstanceOf(\DateInterval::class, $interval);
$this->assertEquals('+2 days', $interval->format('%R%a days'));
}
/**
* Tests that chained calls to non-existent functions throw an exception.
*
* @covers ::__call
*/
public function testChainableNonCallable() : void {
$this->expectException(\BadMethodCallException::class);
$this->expectExceptionMessage('Call to undefined method Drupal\\Core\\Datetime\\DrupalDateTime::nonexistent()');
$tz = new \DateTimeZone(date_default_timezone_get());
$date = new DrupalDateTime('now', $tz, [
'langcode' => 'en',
]);
$date->setTimezone(new \DateTimeZone('America/New_York'))
->nonexistent();
}
/**
* @covers ::getPhpDateTime
*/
public function testGetPhpDateTime() : void {
$new_york = new \DateTimeZone('America/New_York');
$berlin = new \DateTimeZone('Europe/Berlin');
// Test retrieving a cloned copy of the wrapped \DateTime object, and that
// altering it does not change the DrupalDateTime object.
$drupal_date_time = DrupalDateTime::createFromFormat('Y-m-d H:i:s', '2017-07-13 22:40:00', $new_york, [
'langcode' => 'en',
]);
$this->assertEquals(1500000000, $drupal_date_time->getTimestamp());
$this->assertEquals('America/New_York', $drupal_date_time->getTimezone()
->getName());
$datetime = $drupal_date_time->getPhpDateTime();
$this->assertInstanceOf('DateTime', $datetime);
$this->assertEquals(1500000000, $datetime->getTimestamp());
$this->assertEquals('America/New_York', $datetime->getTimezone()
->getName());
$datetime->setTimestamp(1400000000)
->setTimezone($berlin);
$this->assertEquals(1400000000, $datetime->getTimestamp());
$this->assertEquals('Europe/Berlin', $datetime->getTimezone()
->getName());
$this->assertEquals(1500000000, $drupal_date_time->getTimestamp());
$this->assertEquals('America/New_York', $drupal_date_time->getTimezone()
->getName());
}
/**
* Tests that an RFC2822 formatted date always returns an English string.
*
* @see http://www.faqs.org/rfcs/rfc2822.html
*
* @covers ::format
*/
public function testRfc2822DateFormat() : void {
$language_manager = $this->createMock(LanguageManager::class);
$language_manager->expects($this->any())
->method('getCurrentLanguage')
->willReturn(new Language([
'id' => $this->randomMachineName(2),
]));
$container = new ContainerBuilder();
$container->set('language_manager', $language_manager);
\Drupal::setContainer($container);
$time = '2019-02-02T13:30';
$timezone = new \DateTimeZone('Europe/Berlin');
$langcodes = array_keys(LanguageManager::getStandardLanguageList());
$langcodes[] = NULL;
foreach ($langcodes as $langcode) {
$datetime = new DrupalDateTime($time, $timezone, [
'langcode' => $langcode,
]);
// Check that RFC2822 format date is returned regardless of langcode.
$this->assertEquals('Sat, 02 Feb 2019 13:30:00 +0100', $datetime->format('r'));
}
}
/**
* Test to avoid serialization of formatTranslationCache.
*/
public function testSleep() : void {
$tz = new \DateTimeZone(date_default_timezone_get());
$date = new DrupalDateTime('now', $tz, [
'langcode' => 'en',
]);
// Override timestamp before serialize.
$date->setTimestamp(12345678);
$vars = $date->__sleep();
$this->assertContains('langcode', $vars);
$this->assertContains('dateTimeObject', $vars);
$this->assertNotContains('formatTranslationCache', $vars);
$unserialized_date = unserialize(serialize($date));
$this->assertSame(12345678, $unserialized_date->getTimestamp());
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
DrupalDateTimeTest::providerTestDateDiff | public static | function | Provides data for date tests. | |
DrupalDateTimeTest::providerTestInvalidDateDiff | public static | function | Provides data for date tests. | |
DrupalDateTimeTest::testChainable | public | function | Tests that object methods are chainable. | |
DrupalDateTimeTest::testChainableNonCallable | public | function | Tests that chained calls to non-existent functions throw an exception. | |
DrupalDateTimeTest::testChainableNonChainable | public | function | Tests that non-chainable methods work. | |
DrupalDateTimeTest::testDateDiff | public | function | Tests date diffs. | |
DrupalDateTimeTest::testDefaultDateTime | public | function | Tests setting the default time for date-only objects. | |
DrupalDateTimeTest::testGetPhpDateTime | public | function | @covers ::getPhpDateTime | |
DrupalDateTimeTest::testInvalidDateDiff | public | function | Tests date diff exception caused by invalid input. | |
DrupalDateTimeTest::testRfc2822DateFormat | public | function | Tests that an RFC2822 formatted date always returns an English string. | |
DrupalDateTimeTest::testSleep | public | function | Test to avoid serialization of formatTranslationCache. | |
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
UnitTestCase::$root | protected | property | The app root. | |
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUp | protected | function | 367 | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.