Small DocBlock update (OpenMage#4160)

sreichel · kiatng · web-flow · commit 220399dcbc8a · 2024-09-02T13:49:24.000+08:00
* Rector: CQ - UnusedForeachValueToArrayKeysRector (#1) * Rector: CQ - UnusedForeachValueToArrayKeysRector See Rector\CodeQuality\Rector\Foreach_\UnusedForeachValueToArrayKeysRector * fixes + phpstan See fix at rector: rectorphp/rector-src#6164 * Revert "Rector: CQ - UnusedForeachValueToArrayKeysRector (#1)" This reverts commit 3d7eaf6. * DocBlock update * Update app/code/core/Mage/Adminhtml/Helper/Help/Mapping.php Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com> * Update app/code/core/Mage/Core/Model/Session/Abstract.php Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com> * Update app/code/core/Mage/Core/Model/Session/Abstract.php Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com> --------- Co-authored-by: Ng Kiat Siong <kiatsiong.ng@gmail.com>
diff --git a/app/code/core/Mage/Adminhtml/Helper/Help/Mapping.php b/app/code/core/Mage/Adminhtml/Helper/Help/Mapping.php
@@ -231,7 +231,7 @@ protected function findInMapping($frontModule, $controllerName, $actionName)
     /**
      * Determine which version of docs should target onto
      *
-     * @return string
+     * @return Mage_Core_Model_Config_Element|Varien_Simplexml_Element|false
      */
     protected function getHelpTargetVersion()
     {
diff --git a/app/code/core/Mage/CatalogSearch/Model/Resource/Search/Collection.php b/app/code/core/Mage/CatalogSearch/Model/Resource/Search/Collection.php
@@ -105,7 +105,7 @@ protected function _hasAttributeOptionsAndSearchable($attribute)
      * Retrieve SQL for search entities
      *
      * @param string $query
-     * @return string
+     * @return Varien_Db_Select
      */
     protected function _getSearchEntityIdsSql($query)
     {
@@ -168,7 +168,7 @@ protected function _getSearchEntityIdsSql($query)
      * Retrieve SQL for search entities by option
      *
      * @param string $query
-     * @return false|string
+     * @return false|Varien_Db_Select
      */
     protected function _getSearchInOptionSql($query)
     {
diff --git a/app/code/core/Mage/Core/Model/Session/Abstract.php b/app/code/core/Mage/Core/Model/Session/Abstract.php
@@ -524,7 +524,7 @@ public function getSessionHosts()
     /**
      * Retrieve session save method
      *
-     * @return string
+     * @return Mage_Core_Model_Config_Element|Varien_Simplexml_Element|false|string
      */
     public function getSessionSaveMethod()
     {
@@ -537,7 +537,7 @@ public function getSessionSaveMethod()
     /**
      * Get session save path
      *
-     * @return string
+     * @return Mage_Core_Model_Config_Element|Varien_Simplexml_Element|false|string
      */
     public function getSessionSavePath()
     {
diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php
@@ -173,7 +173,7 @@ public function showStoreInfo()
      * @deprecated after 1.4.0.0-rc1
      *
      * @param string $field
-     * @return string
+     * @return string|Zend_Db_Expr
      */
     public function _getFieldTableAlias($field)
     {
diff --git a/app/code/core/Mage/Sales/Model/Resource/Report/Invoiced/Collection/Order.php b/app/code/core/Mage/Sales/Model/Resource/Report/Invoiced/Collection/Order.php
@@ -24,7 +24,7 @@ class Mage_Sales_Model_Resource_Report_Invoiced_Collection_Order extends Mage_Sa
     /**
      * Period format
      *
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/app/code/core/Mage/Sales/Model/Resource/Report/Order/Collection.php b/app/code/core/Mage/Sales/Model/Resource/Report/Order/Collection.php
@@ -24,7 +24,7 @@ class Mage_Sales_Model_Resource_Report_Order_Collection extends Mage_Sales_Model
     /**
      * Period format
      *
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/app/code/core/Mage/Sales/Model/Resource/Report/Refunded/Collection/Order.php b/app/code/core/Mage/Sales/Model/Resource/Report/Refunded/Collection/Order.php
@@ -24,7 +24,7 @@ class Mage_Sales_Model_Resource_Report_Refunded_Collection_Order extends Mage_Sa
     /**
      * Period format
      *
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/app/code/core/Mage/Sales/Model/Resource/Report/Shipping/Collection/Order.php b/app/code/core/Mage/Sales/Model/Resource/Report/Shipping/Collection/Order.php
@@ -24,7 +24,7 @@ class Mage_Sales_Model_Resource_Report_Shipping_Collection_Order extends Mage_Sa
     /**
      * Period format
      *
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/app/code/core/Mage/SalesRule/Model/Resource/Report/Collection.php b/app/code/core/Mage/SalesRule/Model/Resource/Report/Collection.php
@@ -24,7 +24,7 @@ class Mage_SalesRule_Model_Resource_Report_Collection extends Mage_Sales_Model_R
     /**
      * Period format for report (day, month, year)
      *
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/app/code/core/Mage/Tax/Model/Resource/Report/Collection.php b/app/code/core/Mage/Tax/Model/Resource/Report/Collection.php
@@ -22,7 +22,7 @@
 class Mage_Tax_Model_Resource_Report_Collection extends Mage_Sales_Model_Resource_Report_Collection_Abstract
 {
     /**
-     * @var string
+     * @var Zend_Db_Expr
      */
     protected $_periodFormat;
 
diff --git a/lib/Varien/Db/Adapter/Pdo/Mysql.php b/lib/Varien/Db/Adapter/Pdo/Mysql.php
@@ -277,7 +277,7 @@ public function getTransactionLevel()
      * Convert date to DB format
      *
      * @param   int|string|Zend_Date $date
-     * @return  string
+     * @return  Zend_Db_Expr
      */
     public function convertDate($date)
     {
@@ -288,11 +288,11 @@ public function convertDate($date)
      * Convert date and time to DB format
      *
      * @param   int|string|Zend_Date $datetime
-     * @return  string
+     * @return  Zend_Db_Expr
      */
     public function convertDateTime($datetime)
     {
-        return $this->formatDate($datetime, true);
+        return $this->formatDate($datetime);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -231,7 +231,7 @@ protected function findInMapping($frontModule, $controllerName, $actionName)`
`231`	`231`	`/**`
`232`	`232`	`* Determine which version of docs should target onto`
`233`	`233`	`*`
`234`		`- * @return string`
	`234`	`+ * @return Mage_Core_Model_Config_Element\|Varien_Simplexml_Element\|false`
`235`	`235`	`*/`
`236`	`236`	`protected function getHelpTargetVersion()`
`237`	`237`	`{`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ protected function _hasAttributeOptionsAndSearchable($attribute)`
`105`	`105`	`* Retrieve SQL for search entities`
`106`	`106`	`*`
`107`	`107`	`* @param string $query`
`108`		`- * @return string`
	`108`	`+ * @return Varien_Db_Select`
`109`	`109`	`*/`
`110`	`110`	`protected function _getSearchEntityIdsSql($query)`
`111`	`111`	`{`
`@@ -168,7 +168,7 @@ protected function _getSearchEntityIdsSql($query)`
`168`	`168`	`* Retrieve SQL for search entities by option`
`169`	`169`	`*`
`170`	`170`	`* @param string $query`
`171`		`- * @return false\|string`
	`171`	`+ * @return false\|Varien_Db_Select`
`172`	`172`	`*/`
`173`	`173`	`protected function _getSearchInOptionSql($query)`
`174`	`174`	`{`
Original file line number	Diff line number	Diff line change
`@@ -524,7 +524,7 @@ public function getSessionHosts()`
`524`	`524`	`/**`
`525`	`525`	`* Retrieve session save method`
`526`	`526`	`*`
`527`		`- * @return string`
	`527`	`+ * @return Mage_Core_Model_Config_Element\|Varien_Simplexml_Element\|false\|string`
`528`	`528`	`*/`
`529`	`529`	`public function getSessionSaveMethod()`
`530`	`530`	`{`
`@@ -537,7 +537,7 @@ public function getSessionSaveMethod()`
`537`	`537`	`/**`
`538`	`538`	`* Get session save path`
`539`	`539`	`*`
`540`		`- * @return string`
	`540`	`+ * @return Mage_Core_Model_Config_Element\|Varien_Simplexml_Element\|false\|string`
`541`	`541`	`*/`
`542`	`542`	`public function getSessionSavePath()`
`543`	`543`	`{`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ public function showStoreInfo()`
`173`	`173`	`* @deprecated after 1.4.0.0-rc1`
`174`	`174`	`*`
`175`	`175`	`* @param string $field`
`176`		`- * @return string`
	`176`	`+ * @return string\|Zend_Db_Expr`
`177`	`177`	`*/`
`178`	`178`	`public function _getFieldTableAlias($field)`
`179`	`179`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class Mage_Sales_Model_Resource_Report_Invoiced_Collection_Order extends Mage_Sa`
`24`	`24`	`/**`
`25`	`25`	`* Period format`
`26`	`26`	`*`
`27`		`- * @var string`
	`27`	`+ * @var Zend_Db_Expr`
`28`	`28`	`*/`
`29`	`29`	`protected $_periodFormat;`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ class Mage_SalesRule_Model_Resource_Report_Collection extends Mage_Sales_Model_R`
`24`	`24`	`/**`
`25`	`25`	`* Period format for report (day, month, year)`
`26`	`26`	`*`
`27`		`- * @var string`
	`27`	`+ * @var Zend_Db_Expr`
`28`	`28`	`*/`
`29`	`29`	`protected $_periodFormat;`
`30`	`30`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`class Mage_Tax_Model_Resource_Report_Collection extends Mage_Sales_Model_Resource_Report_Collection_Abstract`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * @var string`
	`25`	`+ * @var Zend_Db_Expr`
`26`	`26`	`*/`
`27`	`27`	`protected $_periodFormat;`
`28`	`28`
Original file line number	Diff line number	Diff line change
`@@ -277,7 +277,7 @@ public function getTransactionLevel()`
`277`	`277`	`* Convert date to DB format`
`278`	`278`	`*`
`279`	`279`	`* @param int\|string\|Zend_Date $date`
`280`		`- * @return string`
	`280`	`+ * @return Zend_Db_Expr`
`281`	`281`	`*/`
`282`	`282`	`public function convertDate($date)`
`283`	`283`	`{`
`@@ -288,11 +288,11 @@ public function convertDate($date)`
`288`	`288`	`* Convert date and time to DB format`
`289`	`289`	`*`
`290`	`290`	`* @param int\|string\|Zend_Date $datetime`
`291`		`- * @return string`
	`291`	`+ * @return Zend_Db_Expr`
`292`	`292`	`*/`
`293`	`293`	`public function convertDateTime($datetime)`
`294`	`294`	`{`
`295`		`- return $this->formatDate($datetime, true);`
	`295`	`+ return $this->formatDate($datetime);`
`296`	`296`	`}`
`297`	`297`
`298`	`298`	`/**`