MAGETWO-65722: [GitHub][PR] Type hint for \DateTimeInterface instead of \DateTime magento/magento2#7174

ishakhsuvarov · web-flow · commit 9fde991c6f44 · 2017-07-04T12:15:42.000+03:00
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Date.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Date.php
@@ -131,7 +131,7 @@ public function getHtml()
     public function getEscapedValue($index = null)
     {
         $value = $this->getValue($index);
-        if ($value instanceof \DateTime) {
+        if ($value instanceof \DateTimeInterface) {
             return $this->dateTimeFormatter->formatObject(
                 $value,
                 $this->_localeDate->getDateFormat(\IntlDateFormatter::SHORT)
diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php
@@ -147,7 +147,7 @@ public function getEscapedValue($index = null)
     {
         if ($this->getColumn()->getFilterTime()) {
             $value = $this->getValue($index);
-            if ($value instanceof \DateTime) {
+            if ($value instanceof \DateTimeInterface) {
                 return $this->_localeDate->formatDateTime($value);
             }
             return $value;
diff --git a/app/code/Magento/CatalogRule/Model/ResourceModel/Rule.php b/app/code/Magento/CatalogRule/Model/ResourceModel/Rule.php
@@ -153,7 +153,7 @@ protected function _afterDelete(\Magento\Framework\Model\AbstractModel $rule)
      * Get catalog rules product price for specific date, website and
      * customer group
      *
-     * @param \DateTime $date
+     * @param \DateTimeInterface $date
      * @param int $wId
      * @param int $gId
      * @param int $pId
@@ -173,13 +173,13 @@ public function getRulePrice($date, $wId, $gId, $pId)
      * Retrieve product prices by catalog rule for specific date, website and customer group
      * Collect data with  product Id => price pairs
      *
-     * @param \DateTime $date
+     * @param \DateTimeInterface $date
      * @param int $websiteId
      * @param int $customerGroupId
      * @param array $productIds
      * @return array
      */
-    public function getRulePrices(\DateTime $date, $websiteId, $customerGroupId, $productIds)
+    public function getRulePrices(\DateTimeInterface $date, $websiteId, $customerGroupId, $productIds)
     {
         $connection = $this->getConnection();
         $select = $connection->select()
diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Backend/Datetime.php b/app/code/Magento/Eav/Model/Entity/Attribute/Backend/Datetime.php
@@ -65,7 +65,7 @@ public function beforeSave($object)
      * string format used from input fields (all date input fields need apply locale settings)
      * int value can be declared in code (this meen whot we use valid date)
      *
-     * @param string|int|\DateTime $date
+     * @param string|int|\DateTimeInterface $date
      * @return string
      */
     public function formatDate($date)
@@ -76,7 +76,7 @@ public function formatDate($date)
         // unix timestamp given - simply instantiate date object
         if (is_scalar($date) && preg_match('/^[0-9]+$/', $date)) {
             $date = (new \DateTime())->setTimestamp($date);
-        } elseif (!($date instanceof \DateTime)) {
+        } elseif (!($date instanceof \DateTimeInterface)) {
             // normalized format expecting Y-m-d[ H:i:s]  - time is optional
             $date = new \DateTime($date);
         }
diff --git a/app/code/Magento/Indexer/Model/Mview/View/State.php b/app/code/Magento/Indexer/Model/Mview/View/State.php
@@ -140,7 +140,7 @@ public function getUpdated()
     /**
      * Set state updated time
      *
-     * @param string|int|\DateTime $updated
+     * @param string|int|\DateTimeInterface $updated
      * @return $this
      */
     public function setUpdated($updated)
diff --git a/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php b/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php
@@ -188,8 +188,8 @@ protected function _clearTableByDateRange(
      * @param string $table
      * @param string $column
      * @param string $whereColumn
-     * @param null|string|\DateTime $from
-     * @param null|string|\DateTime $to
+     * @param null|string|\DateTimeInterface $from
+     * @param null|string|\DateTimeInterface $to
      * @param [][] $additionalWhere
      * @param string $alias
      * @return \Magento\Framework\DB\Select
@@ -440,12 +440,12 @@ protected function _getTZOffsetTransitions($timezone, $from = null, $to = null)
         $tzTransitions = [];
         try {
             if (!empty($from)) {
-                $from = $from instanceof \DateTime
+                $from = $from instanceof \DateTimeInterface
                     ? $from->getTimestamp()
                     : (new \DateTime($from))->getTimestamp();
             }
 
-            $to = $to instanceof \DateTime
+            $to = $to instanceof \DateTimeInterface
                 ? $to
                 : new \DateTime($to);
             $nextPeriod = $this->getConnection()->formatDate(
diff --git a/app/code/Magento/Reports/Model/ResourceModel/Report/Collection.php b/app/code/Magento/Reports/Model/ResourceModel/Report/Collection.php
@@ -19,14 +19,14 @@ class Collection extends \Magento\Framework\Data\Collection
     /**
      * From value
      *
-     * @var string
+     * @var \DateTime
      */
     protected $_from;
 
     /**
      * To value
      *
-     * @var string
+     * @var \DateTime
      */
     protected $_to;
 
@@ -114,14 +114,14 @@ public function setPeriod($period)
      * Set interval
      * @codeCoverageIgnore
      *
-     * @param \DateTime $fromDate
-     * @param \DateTime $toDate
+     * @param \DateTimeInterface $fromDate
+     * @param \DateTimeInterface $toDate
      * @return $this
      */
-    public function setInterval($fromDate, $toDate)
+    public function setInterval(\DateTimeInterface $fromDate, \DateTimeInterface $toDate)
     {
-        $this->_from = $fromDate;
-        $this->_to = $toDate;
+        $this->_from = new \DateTime($fromDate->format('Y-m-d'), $fromDate->getTimezone());
+        $this->_to = new \DateTime($toDate->format('Y-m-d'), $toDate->getTimezone());
 
         return $this;
     }
diff --git a/app/code/Magento/Reports/Test/Unit/Model/ResourceModel/Report/CollectionTest.php b/app/code/Magento/Reports/Test/Unit/Model/ResourceModel/Report/CollectionTest.php
@@ -79,8 +79,8 @@ public function testGetStoreIds()
 
     /**
      * @param string $period
-     * @param \DateTime $fromDate
-     * @param \DateTime $toDate
+     * @param \DateTimeInterface $fromDate
+     * @param \DateTimeInterface $toDate
      * @param int $size
      * @dataProvider intervalsDataProvider
      * @return void
@@ -105,8 +105,8 @@ public function testGetPageSize()
 
     /**
      * @param string $period
-     * @param \DateTime $fromDate
-     * @param \DateTime $toDate
+     * @param \DateTimeInterface $fromDate
+     * @param \DateTimeInterface $toDate
      * @param int $size
      * @dataProvider intervalsDataProvider
      * @return void
diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php
@@ -57,7 +57,7 @@ public function _beforeSave(\Magento\Framework\Model\AbstractModel $object)
     private function resolveDate(\Magento\Framework\Model\AbstractModel $object, $dateIdentifier)
     {
         $date = $object->getData($dateIdentifier);
-        if ($date instanceof \DateTime) {
+        if ($date instanceof \DateTimeInterface) {
             $object->setData($dateIdentifier, $date->format('Y-m-d H:i:s'));
         } elseif (!is_string($date) || empty($date)) {
             $object->setData($dateIdentifier, null);
diff --git a/app/code/Magento/Sales/Block/Adminhtml/Order/View/Tab/History.php b/app/code/Magento/Sales/Block/Adminhtml/Order/View/Tab/History.php
@@ -207,7 +207,7 @@ public function getItemComment(array $item)
      *
      * @param string $label
      * @param bool $notified
-     * @param \DateTime $created
+     * @param \DateTimeInterface $created
      * @param string $comment
      * @return array
      */
diff --git a/app/code/Magento/SalesRule/Model/Coupon/Massgenerator.php b/app/code/Magento/SalesRule/Model/Coupon/Massgenerator.php
@@ -171,7 +171,7 @@ public function generatePool()
             } while ($this->getResource()->exists($code));
 
             $expirationDate = $this->getToDate();
-            if ($expirationDate instanceof \DateTime) {
+            if ($expirationDate instanceof \DateTimeInterface) {
                 $expirationDate = $expirationDate->format('Y-m-d H:i:s');
             }
 
diff --git a/app/code/Magento/Theme/Model/ResourceModel/Design/Collection.php b/app/code/Magento/Theme/Model/ResourceModel/Design/Collection.php
@@ -60,7 +60,7 @@ public function joinStore()
     /**
      * Add date filter to collection
      *
-     * @param null|int|string|\DateTime $date
+     * @param null|int|string|\DateTimeInterface $date
      * @return $this
      */
     public function addDateFilter($date = null)
diff --git a/app/etc/di.xml b/app/etc/di.xml
@@ -6,6 +6,7 @@
  */
 -->
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+    <preference for="DateTimeInterface" type="DateTime" />
     <preference for="Psr\Log\LoggerInterface" type="Magento\Framework\Logger\Monolog" />
     <preference for="Magento\Framework\EntityManager\EntityMetadataInterface" type="Magento\Framework\EntityManager\EntityMetadata" />
     <preference for="Magento\Framework\EntityManager\HydratorInterface" type="Magento\Framework\EntityManager\Hydrator" />
diff --git a/lib/internal/Magento/Framework/DB/Adapter/AdapterInterface.php b/lib/internal/Magento/Framework/DB/Adapter/AdapterInterface.php
@@ -667,7 +667,7 @@ public function quoteTableAs($ident, $alias = null, $auto = false);
     /**
      * Format Date to internal database date format
      *
-     * @param int|string|\DateTime $date
+     * @param int|string|\DateTimeInterface $date
      * @param boolean $includeTime
      * @return \Zend_Db_Expr
      */
diff --git a/lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php b/lib/internal/Magento/Framework/DB/Adapter/Pdo/Mysql.php
@@ -332,7 +332,7 @@ public function getTransactionLevel()
     /**
      * Convert date to DB format
      *
-     * @param int|string|\DateTime $date
+     * @param int|string|\DateTimeInterface $date
      * @return \Zend_Db_Expr
      */
     public function convertDate($date)
@@ -343,7 +343,7 @@ public function convertDate($date)
     /**
      * Convert date and time to DB format
      *
-     * @param   int|string|\DateTime $datetime
+     * @param   int|string|\DateTimeInterface $datetime
      * @return \Zend_Db_Expr
      */
     public function convertDateTime($datetime)
@@ -2746,7 +2746,7 @@ public function addForeignKey(
     /**
      * Format Date to internal database date format
      *
-     * @param int|string|\DateTime $date
+     * @param int|string|\DateTimeInterface $date
      * @param bool $includeTime
      * @return \Zend_Db_Expr
      */
diff --git a/lib/internal/Magento/Framework/Mview/View/StateInterface.php b/lib/internal/Magento/Framework/Mview/View/StateInterface.php
@@ -113,7 +113,7 @@ public function getUpdated();
     /**
      * Set state updated time
      *
-     * @param string|int|\DateTime $updated
+     * @param string|int|\DateTimeInterface $updated
      * @return \Magento\Framework\Mview\View\StateInterface
      */
     public function setUpdated($updated);
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime.php b/lib/internal/Magento/Framework/Stdlib/DateTime.php
@@ -39,14 +39,14 @@ class DateTime
     /**
      * Format date to internal format
      *
-     * @param string|\DateTime|bool|null $date
+     * @param string|\DateTimeInterface|bool|null $date
      * @param boolean $includeTime
      * @return string|null
      * @api
      */
     public function formatDate($date, $includeTime = true)
     {
-        if ($date instanceof \DateTime) {
+        if ($date instanceof \DateTimeInterface) {
             $format = $includeTime ? self::DATETIME_PHP_FORMAT : self::DATE_PHP_FORMAT;
             return $date->format($format);
         } elseif (empty($date)) {
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php b/lib/internal/Magento/Framework/Stdlib/DateTime/DateTime.php
@@ -97,7 +97,7 @@ public function date($format = null, $input = null)
     /**
      * Forms GMT timestamp
      *
-     * @param  int|string $input date in current timezone
+     * @param  int|string|\DateTimeInterface $input date in current timezone
      * @return int
      */
     public function gmtTimestamp($input = null)
@@ -106,6 +106,8 @@ public function gmtTimestamp($input = null)
             return (int)gmdate('U');
         } elseif (is_numeric($input)) {
             $result = $input;
+        } elseif ($input instanceof \DateTimeInterface) {
+            $result = $input->getTimestamp();
         } else {
             $result = strtotime($input);
         }
@@ -128,17 +130,23 @@ public function gmtTimestamp($input = null)
      */
     public function timestamp($input = null)
     {
-        if ($input === null) {
-            $result = $this->gmtTimestamp();
-        } elseif (is_numeric($input)) {
-            $result = $input;
-        } else {
-            $result = strtotime($input);
+        switch (true) {
+            case ($input === null):
+                $result = $this->gmtTimestamp();
+                break;
+            case (is_numeric($input)):
+                $result = $input;
+                break;
+            case ($input instanceof \DateTimeInterface):
+                $result = $input->getTimestamp();
+                break;
+            default:
+                $result = strtotime($input);
         }
+
         $date = $this->_localeDate->date($result);
-        $timestamp = $date->getTimestamp();
-        unset($date);
-        return $timestamp;
+
+        return $date->getTimestamp();
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime/DateTimeFormatter.php b/lib/internal/Magento/Framework/Stdlib/DateTime/DateTimeFormatter.php
@@ -64,7 +64,7 @@ public function formatObject($object, $format = null, $locale = null)
     /**
      * Implements what IntlDateFormatter::formatObject() is in PHP 5.5+
      *
-     * @param \IntlCalendar|\DateTime $object
+     * @param \IntlCalendar|\DateTimeInterface $object
      * @param string|int|array|null $format
      * @param string|null $locale
      * @return string
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime/DateTimeFormatterInterface.php b/lib/internal/Magento/Framework/Stdlib/DateTime/DateTimeFormatterInterface.php
@@ -13,7 +13,7 @@ interface DateTimeFormatterInterface
     /**
      * Returns a translated and localized date string
      *
-     * @param \IntlCalendar|\DateTime $object
+     * @param \IntlCalendar|\DateTimeInterface $object
      * @param string|int|array|null $format
      * @param string|null $locale
      * @return string
diff --git a/lib/internal/Magento/Framework/Stdlib/DateTime/Timezone.php b/lib/internal/Magento/Framework/Stdlib/DateTime/Timezone.php
diff --git a/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/DateTimeFormatterTest.php b/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/DateTimeFormatterTest.php
diff --git a/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/DateTimeTest.php b/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/DateTimeTest.php
diff --git a/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/TimezoneTest.php b/lib/internal/Magento/Framework/Stdlib/Test/Unit/DateTime/TimezoneTest.php
diff --git a/lib/internal/Magento/Framework/View/Element/AbstractBlock.php b/lib/internal/Magento/Framework/View/Element/AbstractBlock.php

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ public function getHtml()`
`131`	`131`	`public function getEscapedValue($index = null)`
`132`	`132`	`{`
`133`	`133`	`$value = $this->getValue($index);`
`134`		`- if ($value instanceof \DateTime) {`
	`134`	`+ if ($value instanceof \DateTimeInterface) {`
`135`	`135`	`return $this->dateTimeFormatter->formatObject(`
`136`	`136`	`$value,`
`137`	`137`	`$this->_localeDate->getDateFormat(\IntlDateFormatter::SHORT)`
Original file line number	Diff line number	Diff line change
`@@ -147,7 +147,7 @@ public function getEscapedValue($index = null)`
`147`	`147`	`{`
`148`	`148`	`if ($this->getColumn()->getFilterTime()) {`
`149`	`149`	`$value = $this->getValue($index);`
`150`		`- if ($value instanceof \DateTime) {`
	`150`	`+ if ($value instanceof \DateTimeInterface) {`
`151`	`151`	`return $this->_localeDate->formatDateTime($value);`
`152`	`152`	`}`
`153`	`153`	`return $value;`
Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ public function getUpdated()`
`140`	`140`	`/**`
`141`	`141`	`* Set state updated time`
`142`	`142`	`*`
`143`		`- * @param string\|int\|\DateTime $updated`
	`143`	`+ * @param string\|int\|\DateTimeInterface $updated`
`144`	`144`	`* @return $this`
`145`	`145`	`*/`
`146`	`146`	`public function setUpdated($updated)`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ public function _beforeSave(\Magento\Framework\Model\AbstractModel $object)`
`57`	`57`	`private function resolveDate(\Magento\Framework\Model\AbstractModel $object, $dateIdentifier)`
`58`	`58`	`{`
`59`	`59`	`$date = $object->getData($dateIdentifier);`
`60`		`- if ($date instanceof \DateTime) {`
	`60`	`+ if ($date instanceof \DateTimeInterface) {`
`61`	`61`	`$object->setData($dateIdentifier, $date->format('Y-m-d H:i:s'));`
`62`	`62`	`} elseif (!is_string($date) \|\| empty($date)) {`
`63`	`63`	`$object->setData($dateIdentifier, null);`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ public function getItemComment(array $item)`
`207`	`207`	`*`
`208`	`208`	`* @param string $label`
`209`	`209`	`* @param bool $notified`
`210`		`- * @param \DateTime $created`
	`210`	`+ * @param \DateTimeInterface $created`
`211`	`211`	`* @param string $comment`
`212`	`212`	`* @return array`
`213`	`213`	`*/`