Search code examples
phpdatetimedst

DateTime object not bound by its timestamp?

Is a DateTime object not bound by its timestamp? Or does getTimestamp() has some kind of side-effect when used on DST change?

Details
When setting the timestamp of a DateTime object which is on DST (meaning the formatted time exists both before/after changing the clock) the returned timestamp differs from the set timestamp.

$ php --version
PHP 7.1.3 (cli) (built: Mar 17 2017 16:59:59) ( NTS )
Copyright (c) 1997-2017 The PHP Group
Zend Engine v3.1.0, Copyright (c) 1998-2017 Zend Technologies

Reproduce
Consider the following php script:

date_default_timezone_set('Europe/Berlin');

$date = new DateTime();
$set_timestamp = 1319932800;
$date->setTimestamp($set_timestamp);
$get_timestamp = $date->getTimestamp();

fwrite(STDERR, $set_timestamp . "\n");  // 1319932800
fwrite(STDERR, $get_timestamp . "\n");  // 1319936400 **(WHY IS THIS DIFFERENT?)**

Why are the printed values not equal?

Solution

  • First of all, the unix timestamp is always in UTC, so it hasn't timezone and DST.

    In other hand, the DateTime object stores local time only (the "local" means what timezone is set in the DateTime instance).

    Therefore you should set timezone to +00:00 or UTC before you set a timestamp for avoid unnecessary time conversions and DST guessing.

    You have two choices:

    1. Set timestamp via constructor of DateTime

    The constructor will overrides the default timezone and explicit set to +00:00 when it got timestamp (started with @) in first parameter:

    $set_timestamp = 1319932800;
$date = new DateTime('@' . $set_timestamp);

print($set_timestamp . "\n");
print($date->getTimestamp() . "\n");

    Info: in this case, the timezone parameter of constructor always will be overridden.

    2. Set timezone before call setTimestamp()

    Call setTimezone() with DateTimeZone('+00:00') or DateTimeZone('UTC') timezone before you call setTimestamp():

    $set_timestamp = 1319932800;
$date = new DateTime();
$date->setTimezone(new DateTimeZone('UTC'));
$date->setTimestamp($set_timestamp);

print($set_timestamp . "\n");
print($date->getTimestamp() . "\n");

    Notes

    Of course, both of these cases the output will be:

    1319932800
1319932800

    The date_default_timezone_set() is unnecessary in these cases, because you don't want to do anything with local time.

    However when you want to print the $date in human readable format (so when you convert the unix timestamp to local time) the timezone will be interesting again.