Wrong return type in stub for DateTime(Immutable)::createFromInterface()

[ondrejmirtes]

Description

These methods behave as if they have static return type: https://3v4l.org/oBrlZ

But in the php-src stubs, they don't:

• php-src/ext/date/php_date.stub.php

  Line 231 in d2bb59c

  public static function createFromInterface(DateTimeInterface $object): DateTime {}

• php-src/ext/date/php_date.stub.php

  Line 409 in d2bb59c

  public static function createFromInterface(DateTimeInterface $object): DateTimeImmutable {}

Originally reported here: phpstan/phpstan#7225

PHP Version

PHP 8.x

Operating System

No response

[cmb69]

Looks like ::createFromMutable() and ::createFromImmutable() have the same issue.

[ondrejmirtes]

It also occurs to me that fixing these might be a BC break for child classes that override these methods?

[cmb69]

Yeah; I wonder why the ::createFromInterface() methods have return type declarations in the first place (and not type hints or tentative-returns).

Maybe @kocsismate can clarify.

[kocsismate]

But in the php-src stubs, they don't:

At the time when these methods were added, we didn't have static unfortunately. :(. (the difference was only a few weeks)

Yeah; I wonder why the ::createFromInterface() methods have return type declarations in the first place (and not type hints or tentative-returns).

Because https://github.com/php/php-src/pull/5016/files#diff-69c5b7520e110ac19361b7b043c1e2b75b8b11c9154557b1927491db2a47643aR149 added these return types immediately.

I think we may add @return static to these methods + a todo to fix the return types in the unforeseeable future.

[kocsismate]

What do you think we should do with DateTimeImmutable::createFromMutable() and DateTime::createFromImmutable(). As far as I see they both have the same issue, but the return types are only tentative. Should we fix them for PHP 8.1? cc @derickr

[kocsismate]

I added 37b3092 for now. But we still have the option to fix the return types for DateTimeImmutable::createFromMutable() and DateTime::createFromImmutable() either in PHP 8.1 or master without a significant BC break (users will only face another deprecation notice).

[derickr]

I think we should fix it only for master.