phpcs-fixer: phpdoc_var_annotation_correct_order (#5056)

* phpcs-fixer: `phpdoc_var_annotation_correct_order`

- see https://cs.symfony.com/doc/rules/phpdoc/phpdoc_var_annotation_correct_order.html

* typo

* fix docs

* minor

* phpcs-fixer

Author: sreichel

.php-cs-fixer.dist.php

@@ -30,6 +30,8 @@
         'phpdoc_single_line_var_spacing' => true,
         // Sorts PHPDoc types.
         'phpdoc_types_order' => true,
+        // @var and @type annotations must have type and name in the correct order.
+        'phpdoc_var_annotation_correct_order' => true,
         // Convert double quotes to single quotes for simple strings.
         'single_quote' => true,
         // Arguments lists, array destructuring lists, arrays that are multi-line, match-lines and parameters lists must have a trailing comma.

app/code/core/Mage/CatalogRule/Model/Observer.php

@@ -298,6 +298,7 @@ public function prepareCatalogProductPriceIndexTable(Varien_Event_Observer $obse
      *
      * @param string $attributeCode
      *
+     * @throws Throwable
      * @return $this
      */
     protected function _checkCatalogRulesAvailability($attributeCode)
@@ -307,10 +308,9 @@ protected function _checkCatalogRulesAvailability($attributeCode)
             ->addAttributeInConditionFilter($attributeCode);
 
         $disabledRulesCount = 0;
+        /** @var Mage_CatalogRule_Model_Rule $rule */
         foreach ($collection as $rule) {
-            /** @var Mage_CatalogRule_Model_Rule $rule */
             $rule->setIsActive(0);
-            /** @var $rule->getConditions() Mage_CatalogRule_Model_Rule_Condition_Combine */
             $this->_removeAttributeFromConditions($rule->getConditions(), $attributeCode);
             $rule->save();
 

app/code/core/Mage/Rule/Model/Condition/Combine.php

@@ -13,7 +13,7 @@
  * @method $this setActions(array $value)
  * @method string getAggregator()
  * @method $this setAggregator(string $value)
- * @method string getAggregatorOption()
+ * @method array|string getAggregatorOption()
  * @method array getAggregatorOptions()
  * @method $this setAggregatorOption(array $value)
  * @method string getPrefix()
@@ -37,7 +37,6 @@ public function prepareConditionSql()
     {
         $wheres = [];
         foreach ($this->getConditions() as $condition) {
-            /** @var Mage_Rule_Model_Condition_Abstract $condition */
             $wheres[] = '(' . $condition->prepareConditionSql() . ')';
         }
 
@@ -115,8 +114,8 @@ public function loadAggregatorOptions()
     public function getAggregatorSelectOptions()
     {
         $opt = [];
-        foreach ($this->getAggregatorOption() as $k => $v) {
-            $opt[] = ['value' => $k, 'label' => $v];
+        foreach ($this->getAggregatorOption() as $key => $value) {
+            $opt[] = ['value' => $key, 'label' => $value];
         }
 
         return $opt;
@@ -136,8 +135,8 @@ public function getAggregatorName()
     public function getAggregatorElement()
     {
         if (is_null($this->getAggregator())) {
-            foreach ($this->getAggregatorOption() as $k => $v) {
-                $this->setAggregator($k);
+            foreach ($this->getAggregatorOption() as $key => $value) {
+                $this->setAggregator($key);
                 break;
             }
         }
@@ -264,8 +263,8 @@ public function loadArray($arr, $key = 'conditions')
                         $this->addCondition($cond);
                         $cond->loadArray($condArr, $key);
                     }
-                } catch (Exception $e) {
-                    Mage::logException($e);
+                } catch (Exception $exception) {
+                    Mage::logException($exception);
                 }
             }
         }
@@ -403,7 +402,7 @@ public function setJsFormObject($form)
     /**
      * Get conditions, if current prefix is undefined use 'conditions' key
      *
-     * @return array
+     * @return Mage_Rule_Model_Condition_Product_Abstract[]
      */
     public function getConditions()
     {
@@ -414,7 +413,7 @@ public function getConditions()
     /**
      * Set conditions, if current prefix is undefined use 'conditions' key
      *
-     * @param array $conditions
+     * @param Mage_Rule_Model_Condition_Product_Abstract[] $conditions
      * @return $this
      */
     public function setConditions($conditions)

app/code/core/Mage/SalesRule/Model/Observer.php

@@ -192,6 +192,7 @@ public function aggregateSalesReportCouponsData($schedule)
      * If rules were found they will be set to inactive and notice will be add to admin session
      *
      * @param string $attributeCode
+     * @throws Throwable
      * @return $this
      */
     protected function _checkSalesRulesAvailability($attributeCode)
@@ -201,10 +202,9 @@ protected function _checkSalesRulesAvailability($attributeCode)
             ->addAttributeInConditionFilter($attributeCode);
 
         $disabledRulesCount = 0;
+        /** @var Mage_SalesRule_Model_Rule $rule */
         foreach ($collection as $rule) {
-            /** @var Mage_SalesRule_Model_Rule $rule */
             $rule->setIsActive(0);
-            /** @var $rule->getConditions() Mage_SalesRule_Model_Rule_Condition_Combine */
             $this->_removeAttributeFromConditions($rule->getConditions(), $attributeCode);
             $this->_removeAttributeFromConditions($rule->getActions(), $attributeCode);
             // phpcs:ignore Ecg.Performance.Loop.ModelLSD