PHPStan: Sitemap, Newsletter and more (#2823)

sreichel · web-flow · commit 355cff5a07cf · 2022-12-20T11:28:31.000Z
diff --git a/app/Mage.php b/app/Mage.php
@@ -829,7 +829,7 @@ public static function isInstalled($options = [])
      *
      * @param array|object|string $message
      * @param int $level
-     * @param string $file
+     * @param string|null $file
      * @param bool $forceLog
      */
     public static function log($message, $level = null, $file = '', $forceLog = false)
diff --git a/app/code/core/Mage/AdminNotification/Helper/Data.php b/app/code/core/Mage/AdminNotification/Helper/Data.php
@@ -33,14 +33,14 @@ class Mage_AdminNotification_Helper_Data extends Mage_Core_Helper_Abstract
     /**
      * Last Notice object
      *
-     * @var Mage_AdminNotification_Model_Inbox
+     * @var Mage_AdminNotification_Model_Inbox|null
      */
     protected $_latestNotice;
 
     /**
      * count of unread notes by type
      *
-     * @var array
+     * @var array|null
      */
     protected $_unreadNoticeCounts;
 
diff --git a/app/code/core/Mage/AdminNotification/Model/Feed.php b/app/code/core/Mage/AdminNotification/Model/Feed.php
@@ -36,7 +36,7 @@ class Mage_AdminNotification_Model_Feed extends Mage_Core_Model_Abstract
     /**
      * Feed url
      *
-     * @var string
+     * @var string|null
      */
     protected $_feedUrl;
 
diff --git a/app/code/core/Mage/Contacts/controllers/IndexController.php b/app/code/core/Mage/Contacts/controllers/IndexController.php
@@ -34,7 +34,7 @@ class Mage_Contacts_IndexController extends Mage_Core_Controller_Front_Action
     public const XML_PATH_ENABLED          = 'contacts/contacts/enabled';
 
     /**
-     * @return void
+     * @return $this
      */
     public function preDispatch()
     {
@@ -43,6 +43,7 @@ public function preDispatch()
         if (!Mage::getStoreConfigFlag(self::XML_PATH_ENABLED)) {
             $this->norouteAction();
         }
+        return $this;
     }
 
     public function indexAction()
diff --git a/app/code/core/Mage/Core/Controller/Varien/Action.php b/app/code/core/Mage/Core/Controller/Varien/Action.php
@@ -196,7 +196,7 @@ public function getFlag($action, $flag = '')
      *
      * @param   string $action
      * @param   string $flag
-     * @param   string|int $value
+     * @param   string|int|bool $value
      * @return  $this
      */
     public function setFlag($action, $flag, $value)
diff --git a/app/code/core/Mage/Core/Model/Email/Template/Filter.php b/app/code/core/Mage/Core/Model/Email/Template/Filter.php
@@ -131,7 +131,7 @@ public function getPlainTemplateMode()
     /**
      * Setter
      *
-     * @param int $storeId
+     * @param Mage_Core_Model_Store|int $storeId
      * @return $this
      */
     public function setStoreId($storeId)
diff --git a/app/code/core/Mage/Customer/Model/Customer.php b/app/code/core/Mage/Customer/Model/Customer.php
@@ -463,7 +463,7 @@ public function getAttributes()
      * Get customer attribute model object
      *
      * @param string $attributeCode
-     * @return Mage_Customer_Model_Entity_Attribute|null
+     * @return Mage_Customer_Model_Customer|null
      * @throws Mage_Core_Exception
      */
     public function getAttribute($attributeCode)
diff --git a/app/code/core/Mage/Newsletter/Model/Problem.php b/app/code/core/Mage/Newsletter/Model/Problem.php
@@ -46,7 +46,7 @@ class Mage_Newsletter_Model_Problem extends Mage_Core_Model_Abstract
     /**
      * Current Subscriber
      *
-     * @var Mage_Newsletter_Model_Subscriber
+     * @var Mage_Newsletter_Model_Subscriber|null
      */
     protected $_subscriber = null;
 
@@ -98,7 +98,7 @@ public function addErrorData(Exception $e)
     /**
      * Retrieve Subscriber
      *
-     * @return Mage_Newsletter_Model_Subscriber
+     * @return Mage_Newsletter_Model_Subscriber|null
      */
     public function getSubscriber()
     {
diff --git a/app/code/core/Mage/Newsletter/Model/Queue.php b/app/code/core/Mage/Newsletter/Model/Queue.php
@@ -56,13 +56,13 @@ class Mage_Newsletter_Model_Queue extends Mage_Core_Model_Template
     /**
      * Newsletter Template object
      *
-     * @var Mage_Newsletter_Model_Template
+     * @var Mage_Newsletter_Model_Template|null
      */
     protected $_template;
 
     /**
      * Subscribers collection
-     * @var Mage_Newsletter_Model_Resource_Subscriber_Collection
+     * @var Mage_Newsletter_Model_Resource_Subscriber_Collection|null
      */
     protected $_subscribersCollection = null;
 
diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Queue.php b/app/code/core/Mage/Newsletter/Model/Resource/Queue.php
@@ -169,7 +169,7 @@ public function getStores(Mage_Newsletter_Model_Queue $queue)
     /**
      * Saving template after saving queue action
      *
-     * @param Mage_Core_Model_Abstract|Mage_Newsletter_Model_Queue $queue
+     * @param Mage_Newsletter_Model_Queue $queue
      * @return $this
      */
     protected function _afterSave(Mage_Core_Model_Abstract $queue)
diff --git a/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php b/app/code/core/Mage/Newsletter/Model/Resource/Subscriber/Collection.php
@@ -75,7 +75,7 @@ protected function _construct()
         $this->_map['fields']['customer_middlename'] = 'customer_middlename_table.value';
         $this->_map['fields']['customer_firstname']  = 'customer_firstname_table.value';
         $this->_map['fields']['type']                = $this->getResource()->getReadConnection()
-            ->getCheckSql('main_table.customer_id = 0', 1, 2);
+            ->getCheckSql('main_table.customer_id = 0', '1', '2');
         $this->_map['fields']['website_id']          = 'store.website_id';
         $this->_map['fields']['group_id']            = 'store.group_id';
         $this->_map['fields']['store_id']            = 'main_table.store_id';
@@ -189,7 +189,7 @@ public function _getFieldTableAlias($field)
         }
 
         if ($field == 'type') {
-            return $this->getConnection()->getCheckSql('main_table.customer_id = 0', 1, 2);
+            return $this->getConnection()->getCheckSql('main_table.customer_id = 0', '1', '2');
         }
 
         if (in_array($field, ['website_id', 'group_id'])) {
diff --git a/app/code/core/Mage/Newsletter/Model/Subscriber.php b/app/code/core/Mage/Newsletter/Model/Subscriber.php
@@ -186,7 +186,7 @@ public function setStatus($value)
     /**
      * Set the error messages scope for subscription
      *
-     * @param bool $scope
+     * @param string $scope
      * @return $this
      */
 
diff --git a/app/code/core/Mage/Newsletter/Model/Template.php b/app/code/core/Mage/Newsletter/Model/Template.php
@@ -65,7 +65,7 @@ class Mage_Newsletter_Model_Template extends Mage_Core_Model_Email_Template_Abst
     /**
      * Mail object
      *
-     * @var Zend_Mail
+     * @var Zend_Mail|null
      */
     protected $_mail;
 
@@ -173,7 +173,7 @@ public function isPreprocessed()
     /**
      * Check Template Text Preprocessed
      *
-     * @return bool
+     * @return string
      */
     public function getTemplateTextPreprocessed()
     {
diff --git a/app/code/core/Mage/Sitemap/Model/Sitemap.php b/app/code/core/Mage/Sitemap/Model/Sitemap.php
@@ -47,7 +47,7 @@ class Mage_Sitemap_Model_Sitemap extends Mage_Core_Model_Abstract
     /**
      * Real file path
      *
-     * @var string
+     * @var string|null
      */
     protected $_filePath;
 
diff --git a/app/code/core/Zend/Db/Select.php b/app/code/core/Zend/Db/Select.php
@@ -758,7 +758,7 @@ public function reset($part = null)
      * Gets the Zend_Db_Adapter_Abstract for this
      * particular Zend_Db_Select object.
      *
-     * @return Zend_Db_Adapter_Abstract
+     * @return Varien_Db_Adapter_Interface|Zend_Db_Adapter_Abstract
      */
     public function getAdapter()
     {
diff --git a/lib/Varien/Data/Collection.php b/lib/Varien/Data/Collection.php
@@ -440,7 +440,7 @@ public function clear()
      *
      * Returns array with results of callback for each item
      *
-     * @param callable $callback
+     * @param string|callable $callback
      * @param array $args
      * @return array
      */
diff --git a/lib/Varien/Http/Adapter/Curl.php b/lib/Varien/Http/Adapter/Curl.php
@@ -196,7 +196,7 @@ public function write($method, $url, $http_ver = '1.1', $headers = [], $body = '
     /**
      * Read response from server
      *
-     * @return string
+     * @return string|bool
      */
     public function read()
     {
diff --git a/phpstan.dist.baseline.neon b/phpstan.dist.baseline.neon
diff --git a/phpstan.dist.neon b/phpstan.dist.neon

Original file line number	Diff line number	Diff line change
`@@ -829,7 +829,7 @@ public static function isInstalled($options = [])`
`829`	`829`	`*`
`830`	`830`	`* @param array\|object\|string $message`
`831`	`831`	`* @param int $level`
`832`		`- * @param string $file`
	`832`	`+ * @param string\|null $file`
`833`	`833`	`* @param bool $forceLog`
`834`	`834`	`*/`
`835`	`835`	`public static function log($message, $level = null, $file = '', $forceLog = false)`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ class Mage_AdminNotification_Model_Feed extends Mage_Core_Model_Abstract`
`36`	`36`	`/**`
`37`	`37`	`* Feed url`
`38`	`38`	`*`
`39`		`- * @var string`
	`39`	`+ * @var string\|null`
`40`	`40`	`*/`
`41`	`41`	`protected $_feedUrl;`
`42`	`42`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class Mage_Contacts_IndexController extends Mage_Core_Controller_Front_Action`
`34`	`34`	`public const XML_PATH_ENABLED = 'contacts/contacts/enabled';`
`35`	`35`
`36`	`36`	`/**`
`37`		`- * @return void`
	`37`	`+ * @return $this`
`38`	`38`	`*/`
`39`	`39`	`public function preDispatch()`
`40`	`40`	`{`
`@@ -43,6 +43,7 @@ public function preDispatch()`
`43`	`43`	`if (!Mage::getStoreConfigFlag(self::XML_PATH_ENABLED)) {`
`44`	`44`	`$this->norouteAction();`
`45`	`45`	`}`
	`46`	`+ return $this;`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`public function indexAction()`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ public function getFlag($action, $flag = '')`
`196`	`196`	`*`
`197`	`197`	`* @param string $action`
`198`	`198`	`* @param string $flag`
`199`		`- * @param string\|int $value`
	`199`	`+ * @param string\|int\|bool $value`
`200`	`200`	`* @return $this`
`201`	`201`	`*/`
`202`	`202`	`public function setFlag($action, $flag, $value)`
Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ public function getPlainTemplateMode()`
`131`	`131`	`/**`
`132`	`132`	`* Setter`
`133`	`133`	`*`
`134`		`- * @param int $storeId`
	`134`	`+ * @param Mage_Core_Model_Store\|int $storeId`
`135`	`135`	`* @return $this`
`136`	`136`	`*/`
`137`	`137`	`public function setStoreId($storeId)`
Original file line number	Diff line number	Diff line change
`@@ -463,7 +463,7 @@ public function getAttributes()`
`463`	`463`	`* Get customer attribute model object`
`464`	`464`	`*`
`465`	`465`	`* @param string $attributeCode`
`466`		`- * @return Mage_Customer_Model_Entity_Attribute\|null`
	`466`	`+ * @return Mage_Customer_Model_Customer\|null`
`467`	`467`	`* @throws Mage_Core_Exception`
`468`	`468`	`*/`
`469`	`469`	`public function getAttribute($attributeCode)`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ class Mage_Newsletter_Model_Problem extends Mage_Core_Model_Abstract`
`46`	`46`	`/**`
`47`	`47`	`* Current Subscriber`
`48`	`48`	`*`
`49`		`- * @var Mage_Newsletter_Model_Subscriber`
	`49`	`+ * @var Mage_Newsletter_Model_Subscriber\|null`
`50`	`50`	`*/`
`51`	`51`	`protected $_subscriber = null;`
`52`	`52`
`@@ -98,7 +98,7 @@ public function addErrorData(Exception $e)`
`98`	`98`	`/**`
`99`	`99`	`* Retrieve Subscriber`
`100`	`100`	`*`
`101`		`- * @return Mage_Newsletter_Model_Subscriber`
	`101`	`+ * @return Mage_Newsletter_Model_Subscriber\|null`
`102`	`102`	`*/`
`103`	`103`	`public function getSubscriber()`
`104`	`104`	`{`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ public function getStores(Mage_Newsletter_Model_Queue $queue)`
`169`	`169`	`/**`
`170`	`170`	`* Saving template after saving queue action`
`171`	`171`	`*`
`172`		`- * @param Mage_Core_Model_Abstract\|Mage_Newsletter_Model_Queue $queue`
	`172`	`+ * @param Mage_Newsletter_Model_Queue $queue`
`173`	`173`	`* @return $this`
`174`	`174`	`*/`
`175`	`175`	`protected function _afterSave(Mage_Core_Model_Abstract $queue)`
Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ public function setStatus($value)`
`186`	`186`	`/**`
`187`	`187`	`* Set the error messages scope for subscription`
`188`	`188`	`*`
`189`		`- * @param bool $scope`
	`189`	`+ * @param string $scope`
`190`	`190`	`* @return $this`
`191`	`191`	`*/`
`192`	`192`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ class Mage_Newsletter_Model_Template extends Mage_Core_Model_Email_Template_Abst`
`65`	`65`	`/**`
`66`	`66`	`* Mail object`
`67`	`67`	`*`
`68`		`- * @var Zend_Mail`
	`68`	`+ * @var Zend_Mail\|null`
`69`	`69`	`*/`
`70`	`70`	`protected $_mail;`
`71`	`71`
`@@ -173,7 +173,7 @@ public function isPreprocessed()`
`173`	`173`	`/**`
`174`	`174`	`* Check Template Text Preprocessed`
`175`	`175`	`*`
`176`		`- * @return bool`
	`176`	`+ * @return string`
`177`	`177`	`*/`
`178`	`178`	`public function getTemplateTextPreprocessed()`
`179`	`179`	`{`