Adds DateTime[Immutable]::createFromTimestamp #12413

marc-mabe · 2023-10-11T09:30:21Z

This creates the following functions:

DateTime::createFromTimestamp(int|float $timestamp): static
DateTimeImmutable::createFromTimestamp(int|float $timestamp): static

The reason for these functions is the very common case of creating a DateTime[Immutable] object from a unix timestamp.
This currently only works by:

special timestamp constructor format @<timestamp>
- needs to be known by studying https://www.php.net/manual/en/datetime.formats.php
- requires stringifying the timestamp
- requires handling edge cases like avoiding scientific notation of floating points
createFromFormat with U / U.u
- same as @<timstamp> but adds additional differences on integer vs. float
(new DateTime(...))->setTimestamp()
- needs instance beforehand which does a current time lookup
- setTimestamp supports integers only (This probably should allow floats as well in a separate PR)

The new functions avoid the above issues, are self explained and are much faster for this common case as well.

The functions will throw a DateRangeError in case of special floating point numbers or out-of-range of signed long long of timelib.

Internals: https://marc.info/?l=php-internals&m=169850186312326

Bench (doesn't even handle scientific notation of floating points):

<?php

$calls = 10000;
$time = time();
$microtime = microtime(true);
$utc = new DateTimeZone('+00:00');

function p(float $start, float $end, int $calls) {
    printf(
        "\t%ss for %s calls (%Fns per call)\n",
        ($end - $start) / 1000000000,
        $calls,
        ($end - $start) / $calls,
    );
}

foreach ([$time, $microtime] as $t) {
    echo '$t = ' . var_export($t, true) . "\n";

    echo 'new DateTime("@" . $t, $utc): ' . "\n";
    $start = hrtime(true);
    for ($i = 0; $i < $calls; $i += 1) {
        $tmp = new DateTime("@" . $t, $utc);
    }
    $end = hrtime(true);
    p($start, $end, $calls);
    //var_dump($tmp);

    if (is_float($t)) {
        echo 'DateTime::createFromFormat("U.u", $t, $utc): ' . "\n";
        $start = hrtime(true);
        for ($i = 0; $i < $calls; $i += 1) {
            $tmp = DateTime::createFromFormat("U.u", $t, $utc);
        }
        $end = hrtime(true);
        p($start, $end, $calls);
    } else {
        echo 'DateTime::createFromFormat("U", $t, $utc): ' . "\n";
        $start = hrtime(true);
        for ($i = 0; $i < $calls; $i += 1) {
            $tmp = DateTime::createFromFormat("U", $t, $utc);
        }
        $end = hrtime(true);
        p($start, $end, $calls);
    }
    //var_dump($tmp);

    echo 'DateTime::createFromTimestamp($t): ' . "\n";
    $start = hrtime(true);
    for ($i = 0; $i < $calls; $i += 1) {
        $tmp = DateTime::createFromTimestamp($t);
    }
    $end = hrtime(true);
    p($start, $end, $calls);
    //var_dump($tmp);
}

$t = 1697016217
new DateTime("@" . $t, $utc): 
        0.012929698s for 10000 calls (1292.969800ns per call)
DateTime::createFromFormat("U", $t, $utc): 
        0.009363419s for 10000 calls (936.341900ns per call)
DateTime::createFromTimestamp($t): 
        0.004168669s for 10000 calls (416.866900ns per call)
$t = 1697016217.492358
new DateTime("@" . $t, $utc): 
        0.013072768s for 10000 calls (1307.276800ns per call)
DateTime::createFromFormat("U.u", $t, $utc): 
        0.012962979s for 10000 calls (1296.297900ns per call)
DateTime::createFromTimestamp($t): 
        0.00396879s for 10000 calls (396.879000ns per call)

…le]_from_timestamp

marc-mabe · 2023-10-28T10:09:17Z

ext/date/php_date.stub.php

@@ -362,6 +368,12 @@ public static function createFromInterface(DateTimeInterface $object): DateTime
     */
    public static function createFromFormat(string $format, string $datetime, ?DateTimeZone $timezone = null): DateTime|false {}

+    /**
+     * @tentative-return-type


@tentative-return-type makes Carbon compatible with deprecation message

kamil-tekiela · 2023-10-28T14:10:50Z

The functions can only return false in case of special floating point numbers or not within range of zend_long.

The signatures you listed do not contain false as a possible return type. Why do these functions return false at all? Why not just throw an exception?

marc-mabe · 2023-10-28T15:39:34Z

The functions can only return false in case of special floating point numbers or not within range of zend_long.

The signatures you listed do not contain false as a possible return type. Why do these functions return false at all? Why not just throw an exception?

@kamil-tekiela Thanks for pointing this out. It has been updated already to throw a DateRangeError as visible in the test. Updated the PR description accordingly.

ext/date/php_date.c

Zend/Optimizer/zend_func_infos.h

…rickr

…rickr

marc-mabe · 2023-11-08T22:00:37Z

@derickr I have updated the PR according to your review

derickr

I think this looks good, but I have one question left.

derickr · 2023-11-15T15:43:37Z

ext/date/tests/createFromTimestamp.phpt

+  ["timezone"]=>
+  string(6) "+00:00"
+}
+DateTime::createFromTimestamp(%f): DateRangeError: Seconds must be a finite number between %i and %i, %f given


Why do you say finite here, and not integer?

I used the word "finite" to cover NAN, +/-INF as well and as a FP is allowed as well "integer" would not be fully correct.
If you feel it's confusing it could also be left out -> "... must be a number between ..."

derickr · 2023-11-22T15:25:41Z

I have merged this after a rebase, squash, and the addition of the NEWS entry. Thanks!

derickr · 2023-11-23T10:26:43Z

@marc-mabe Turns out that this failed tests on x32, can you have a look? https://github.com/php/php-src/actions/runs/6964523973/job/18951903197

marc-mabe · 2023-11-23T10:42:43Z

@marc-mabe Turns out that this failed tests on x32, can you have a look? https://github.com/php/php-src/actions/runs/6964523973/job/18951903197

I'll have a look ... Could you give me a hint for how I can test this without x32 arch 🙏

derickr · 2023-11-23T15:13:33Z

I run compile my 32-bit build like this:

https://github.com/derickr/php-build/blob/master/build#L68
https://github.com/derickr/php-build/blob/master/build#L138

You can probably get away with just --disable-all.

I guess, this would be minimal:

export CFLAGS="-m32"
export PKG_CONFIG_PATH="/usr/lib/i386-linux-gnu/pkgconfig"
./buildconf
./configure --build=i686-pc-linux-gnu --disable-all
make
make test TESTS=ext/date

Closes GH-12964.

…omTimestamp() (derrabus) This PR was merged into the 7.1 branch. Discussion ---------- [Clock] Add a polyfill for DateTimeImmutable::createFromTimestamp() | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | N/A | License | MIT This PR adds the new `createFromTimestamp()` method introduced in php/php-src#12413 to our `DatePoint` class. It comes with a polyfill implementation for PHP 8.2/8.3. Commits ------- 9e48e0d [Clock] Polyfill DateTimeImmutable::createFromTimestamp()

steffenweber · 2025-01-23T09:51:24Z

I'm late to the party but I'm wondering why in contrast to createFromFormat, createFromTimestamp doesn't have a second parameter to specify the timezone. Of course, unix timestamps don't have a timezone but when I'm using the DateTime class to format a date I'll have to call setTimezone now. This feels a little inconvenient (and seems to be a relatively expensive call).

steffenweber · 2025-01-23T12:55:55Z

To answer my own question, createFromFormat actually doesn't use the timezone parameter either in this case: "The $timezone parameter and the current timezone are ignored when the $datetime parameter either is a UNIX timestamp [...]" – https://www.php.net/manual/en/datetime.construct.php

kamil-tekiela · 2025-01-23T13:00:08Z

I'm late to the party but I'm wondering why in contrast to createFromFormat, createFromTimestamp doesn't have a second parameter to specify the timezone. Of course, unix timestamps don't have a timezone but when I'm using the DateTime class to format a date I'll have to call setTimezone now. This feels a little inconvenient (and seems to be a relatively expensive call).

Because a UNIX timestamp already contains a time zone. Specifying a time zone would be redundant as you have found out yourself.

marc-mabe requested review from bukka and derickr as code owners October 11, 2023 09:30

github-actions bot added the Extension: date label Oct 11, 2023

marc-mabe force-pushed the DateTime-createFromTimestamp branch from fcd3402 to 95e12ab Compare October 11, 2023 16:44

Added DateTime[Immutable]::createFromTimestamp / date_create_[immutab…

29eca46

…le]_from_timestamp

marc-mabe force-pushed the DateTime-createFromTimestamp branch from 95e12ab to 29eca46 Compare October 11, 2023 17:25

marc-mabe requested a review from dstogov as a code owner October 11, 2023 17:25

github-actions bot added the Category: Optimizer label Oct 11, 2023

marc-mabe and others added 2 commits October 12, 2023 09:10

fixup

9df735e

DateRangeError + static return type

c7cc823

marc-mabe force-pushed the DateTime-createFromTimestamp branch from 1ac0743 to c7cc823 Compare October 18, 2023 20:26

marc-mabe force-pushed the DateTime-createFromTimestamp branch from d517b20 to c7cc823 Compare October 28, 2023 10:07

marc-mabe commented Oct 28, 2023

View reviewed changes

Tests should pass 32bit now

178f7ce

marc-mabe mentioned this pull request Oct 29, 2023

Added DateTime[Immutable]::[get|set]Microseconds #12557

Merged

derickr reviewed Nov 1, 2023

View reviewed changes

ext/date/php_date.c Outdated Show resolved Hide resolved

Zend/Optimizer/zend_func_infos.h Outdated Show resolved Hide resolved

Removed fn date_create_[immutable_]from_timestamp as suggested by @de…

759a9e4

…rickr

github-actions bot removed the Category: Optimizer label Nov 8, 2023

derickr reviewed Nov 15, 2023

View reviewed changes

derickr added a commit that referenced this pull request Nov 22, 2023

Merged pull request #12413

bfb9922

derickr closed this Nov 22, 2023

marc-mabe deleted the DateTime-createFromTimestamp branch November 22, 2023 15:53

marc-mabe added a commit to marc-mabe/php-src that referenced this pull request Dec 17, 2023

Added UPGRADING entry for php#12413

690c7e1

nielsdos pushed a commit that referenced this pull request Dec 17, 2023

[ci skip] Added UPGRADING entry for GH-12413

5d85378

Closes GH-12964.

derrabus mentioned this pull request Mar 30, 2024

[Clock] Add a polyfill for DateTimeImmutable::createFromTimestamp() symfony/symfony#54442

Merged

ADmad mentioned this pull request Jul 13, 2024

Run testsuite on PHP 8.4 cakephp/cakephp#17740

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds DateTime[Immutable]::createFromTimestamp #12413

Adds DateTime[Immutable]::createFromTimestamp #12413

marc-mabe commented Oct 11, 2023 •

edited

Loading

marc-mabe Oct 28, 2023

kamil-tekiela commented Oct 28, 2023

marc-mabe commented Oct 28, 2023

marc-mabe commented Nov 8, 2023

derickr left a comment

derickr Nov 15, 2023

marc-mabe Nov 15, 2023

derickr commented Nov 22, 2023

derickr commented Nov 23, 2023

marc-mabe commented Nov 23, 2023

derickr commented Nov 23, 2023

steffenweber commented Jan 23, 2025

steffenweber commented Jan 23, 2025

kamil-tekiela commented Jan 23, 2025

Adds DateTime[Immutable]::createFromTimestamp #12413

Adds DateTime[Immutable]::createFromTimestamp #12413

Conversation

marc-mabe commented Oct 11, 2023 • edited Loading

marc-mabe Oct 28, 2023

Choose a reason for hiding this comment

kamil-tekiela commented Oct 28, 2023

marc-mabe commented Oct 28, 2023

marc-mabe commented Nov 8, 2023

derickr left a comment

Choose a reason for hiding this comment

derickr Nov 15, 2023

Choose a reason for hiding this comment

marc-mabe Nov 15, 2023

Choose a reason for hiding this comment

derickr commented Nov 22, 2023

derickr commented Nov 23, 2023

marc-mabe commented Nov 23, 2023

derickr commented Nov 23, 2023

steffenweber commented Jan 23, 2025

steffenweber commented Jan 23, 2025

kamil-tekiela commented Jan 23, 2025

marc-mabe commented Oct 11, 2023 •

edited

Loading