Timezone scopeDate method does not respect interface

[sta1r]

Preconditions (*)

1. 2.3-develop

Steps to reproduce (*)

1. Start with a class similar to this:

<?php

class MyDate
{
    /**
     * @var \Magento\Framework\Stdlib\DateTime\TimezoneInterface
     */
    private $timeZone;

    /**
     * @param \Magento\Framework\Stdlib\DateTime\TimezoneInterface $timezone
     */
    public function __construct(
        \Magento\Framework\Stdlib\DateTime\TimezoneInterface $timezone
    ) {
        $this->timeZone = $timezone;

        $scopedDate = $this->timeZone->scopeDate(1, new \DateTime, true);
    }
}

2. Run the code

Expected result (*)

1. scopeDate() returns a DateTime scoped to the store 1 locale.
2. The method should work according to signature in the interface - support all types

Actual result (*)

1. PHP Fatal error is thrown

PHP Fatal error:  Uncaught TypeError: DateTime::__construct() expects parameter 1 to be string, object given

The scopeDate() method is not implementing its interface (or at least the docBlock of the interface, which indicates this method can take a DateTime as $date).

[m2-assistant]

Hi @sta1r. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.3-develop instance - upcoming 2.3.x release

For more details, please, review the Magento Contributor Assistant documentation.

@sta1r do you confirm that you were able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

---

• Join Magento Community Engineering Slack and ask your questions in #github channel.

[sta1r]

Should it take a DateTime or not? Happy to submit a fix either way.

[m2-assistant]

Hi @engcom-Delta. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• 6. Add label Issue: Confirmed once verification is complete.

• 7. Make sure that automatic system confirms that report has been added to the backlog.

[magento-engcom-team]

✅ Confirmed by @sdzhepa
Thank you for verifying the issue. Based on the provided information internal tickets MC-18044 were created

Issue Available: @sdzhepa, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[edenduong]

I think we should implement it like date(..) function in the same class:

#23693

[magento-engcom-team]

Hi @sta1r. Thank you for your report.
The issue has been fixed in #23693 by @edenduong in 2.3-develop branch
Related commit(s):

• 4b7f8e5544479087a32cfbfe1c4f5a116a208e53

The fix will be available with the upcoming 2.3.4 release.