Fix many PHPSTAN issues

apacios · apacios · commit 368707dee363 · 2020-05-07T16:38:50.000+02:00
diff --git a/classes/GoogleAnalyticsTools.php b/classes/GoogleAnalyticsTools.php
@@ -64,7 +64,7 @@ public function addTransaction($products, $order)
     /**
      * add product impression js and product click js
      *
-     * @param array ixed $products
+     * @param array $products
      *
      * @return string|void
      */
diff --git a/classes/Handler/GanalyticsJsHandler.php b/classes/Handler/GanalyticsJsHandler.php
@@ -25,7 +25,7 @@ class GanalyticsJsHandler
     private $module;
     private $context;
 
-    public function __construct(\Ps_googleanalytics $module, \Context $context)
+    public function __construct(\Ps_Googleanalytics $module, \Context $context)
     {
         $this->module = $module;
         $this->context = $context;
@@ -37,7 +37,7 @@ public function __construct(\Ps_googleanalytics $module, \Context $context)
      * @param string $jsCode
      * @param int $isBackoffice
      *
-     * @return string
+     * @return void|string
      */
     public function generate($jsCode, $isBackoffice = 0)
     {
diff --git a/classes/Hook/HookActionProductCancel.php b/classes/Hook/HookActionProductCancel.php
@@ -35,7 +35,7 @@ public function __construct($module, $context)
     /**
      * run
      *
-     * @return string
+     * @return void
      */
     public function run()
     {
diff --git a/classes/Hook/HookDisplayFooter.php b/classes/Hook/HookDisplayFooter.php
@@ -85,7 +85,7 @@ public function run()
             if (empty($step)) {
                 $step = 0;
             }
-            $gaScripts .= $gaTools->addProductFromCheckout($products, $step);
+            $gaScripts .= $gaTools->addProductFromCheckout($products);
             $gaScripts .= 'MBG.addCheckout(\'' . (int) $step . '\');';
         }
 
diff --git a/classes/Hook/HookDisplayHeader.php b/classes/Hook/HookDisplayHeader.php
@@ -36,7 +36,7 @@ public function __construct($module, $context)
     /**
      * run
      *
-     * @return string
+     * @return void|string
      */
     public function run()
     {
diff --git a/classes/Hook/HookDisplayHome.php b/classes/Hook/HookDisplayHome.php
@@ -65,7 +65,7 @@ public function run()
             $gaScripts .= $gaTools->addProductImpression($homeFeaturedProducts) . $gaTools->addProductClick($homeFeaturedProducts);
         }
 
-        $this->js_state = 1;
+        $this->module->js_state = 1;
 
         return $gaTagHandler->generate(
             $gaTools->filter($gaScripts, $this->module->filterable)
diff --git a/classes/Hook/HookDisplayOrderConfirmation.php b/classes/Hook/HookDisplayOrderConfirmation.php
@@ -92,6 +92,8 @@ public function run()
                 }
             }
         }
+
+        return '';
     }
 
     /**
diff --git a/classes/Repository/GanalyticsDataRepository.php b/classes/Repository/GanalyticsDataRepository.php
@@ -47,7 +47,7 @@ public function findDataByCartIdAndShopId($cartId, $shopId)
      *
      * @param int $cartId
      * @param int $shopId
-     * @param array $data
+     * @param string $data
      *
      * @return bool
      */
@@ -66,7 +66,7 @@ public function addNewRow($cartId, $shopId, $data)
      * @param int $cartId
      * @param int $shopId
      *
-     * @return void
+     * @return bool
      */
     public function deleteRow($cartId, $shopId)
     {
diff --git a/classes/Repository/GanalyticsRepository.php b/classes/Repository/GanalyticsRepository.php
@@ -61,7 +61,7 @@ public function findAllByShopIdAndDateAdd($shopId)
      * addNewRow
      *
      * @param array $data
-     * @param \Db $type
+     * @param int $type
      *
      * @return bool
      */
diff --git a/classes/Wrapper/ProductWrapper.php b/classes/Wrapper/ProductWrapper.php
@@ -51,7 +51,7 @@ public function wrapProductList($products, $extras = [], $full = false)
         }
 
         foreach ($products as $index => $product) {
-            if ($product instanceof Product) {
+            if ($product instanceof \Product) {
                 $product = (array) $product;
             }
 
diff --git a/ps_googleanalytics.php b/ps_googleanalytics.php
@@ -30,6 +30,16 @@ class Ps_Googleanalytics extends Module
      */
     const PS_16_EQUIVALENT_MODULE = 'ganalytics';
 
+    public $name;
+    public $tab;
+    public $version;
+    public $ps_versions_compliancy;
+    public $author;
+    public $module_key;
+    public $bootstrap;
+    public $displayName;
+    public $description;
+    public $confirmUninstall;
     public $js_state = 0;
     public $eligible = 0;
     public $filterable = 1;
@@ -153,8 +163,7 @@ public function hookactionProductCancel($params)
     {
         $hook = new PrestaShop\Module\Ps_Googleanalytics\Hooks\HookActionProductCancel($this, $this->context);
         $hook->setParams($params);
-
-        return $hook->run();
+        $hook->run();
     }
 
     /**
@@ -163,16 +172,14 @@ public function hookactionProductCancel($params)
     public function hookactionCartSave()
     {
         $hook = new PrestaShop\Module\Ps_Googleanalytics\Hooks\HookActionCartSave($this, $this->context);
-
-        return $hook->run();
+        $hook->run();
     }
 
     public function hookactionCarrierProcess($params)
     {
         $hook = new PrestaShop\Module\Ps_Googleanalytics\Hooks\HookActionCarrierProcess($this, $this->context);
         $hook->setParams($params);
-
-        return $hook->run();
+        $hook->run();
     }
 
     protected function _debugLog($function, $log)
diff --git a/tests/phpstan/phpstan.neon b/tests/phpstan/phpstan.neon
@@ -1,11 +1,14 @@
 includes:
-  - %currentWorkingDirectory%/vendor/prestashop/php-dev-tools/phpstan/extension.neon
+	- %currentWorkingDirectory%/vendor/prestashop/php-dev-tools/phpstan/ps-module-extension.neon
 
 parameters:
-  paths:
-  # We consider that the extension file will be stored the folder test/phpstan
-  # From Phpstan 0.12, paths are relative to the .neon file.
-  # - ../../classes
-  # - ../../controllers
-  reportUnmatchedIgnoredErrors: false
-  level: max
+	paths:
+		- ../../classes
+		- ../../controllers
+		- ../../ps_googleanalytics.php
+	reportUnmatchedIgnoredErrors: false
+	ignoreErrors:
+		- '#Property Ps_Googleanalytics::\$version \(float\) does not accept string.#'
+		- '#Strict comparison using === between false and Module will always evaluate to false.#'
+
+	level: 5

Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ public function addTransaction($products, $order)`
`64`	`64`	`/**`
`65`	`65`	`* add product impression js and product click js`
`66`	`66`	`*`
`67`		`- * @param array ixed $products`
	`67`	`+ * @param array $products`
`68`	`68`	`*`
`69`	`69`	`* @return string\|void`
`70`	`70`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class GanalyticsJsHandler`
`25`	`25`	`private $module;`
`26`	`26`	`private $context;`
`27`	`27`
`28`		`- public function __construct(\Ps_googleanalytics $module, \Context $context)`
	`28`	`+ public function __construct(\Ps_Googleanalytics $module, \Context $context)`
`29`	`29`	`{`
`30`	`30`	`$this->module = $module;`
`31`	`31`	`$this->context = $context;`
`@@ -37,7 +37,7 @@ public function __construct(\Ps_googleanalytics $module, \Context $context)`
`37`	`37`	`* @param string $jsCode`
`38`	`38`	`* @param int $isBackoffice`
`39`	`39`	`*`
`40`		`- * @return string`
	`40`	`+ * @return void\|string`
`41`	`41`	`*/`
`42`	`42`	`public function generate($jsCode, $isBackoffice = 0)`
`43`	`43`	`{`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct($module, $context)`
`35`	`35`	`/**`
`36`	`36`	`* run`
`37`	`37`	`*`
`38`		`- * @return string`
	`38`	`+ * @return void`
`39`	`39`	`*/`
`40`	`40`	`public function run()`
`41`	`41`	`{`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ public function run()`
`85`	`85`	`if (empty($step)) {`
`86`	`86`	`$step = 0;`
`87`	`87`	`}`
`88`		`- $gaScripts .= $gaTools->addProductFromCheckout($products, $step);`
	`88`	`+ $gaScripts .= $gaTools->addProductFromCheckout($products);`
`89`	`89`	`$gaScripts .= 'MBG.addCheckout(\'' . (int) $step . '\');';`
`90`	`90`	`}`
`91`	`91`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct($module, $context)`
`36`	`36`	`/**`
`37`	`37`	`* run`
`38`	`38`	`*`
`39`		`- * @return string`
	`39`	`+ * @return void\|string`
`40`	`40`	`*/`
`41`	`41`	`public function run()`
`42`	`42`	`{`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function run()`
`65`	`65`	`$gaScripts .= $gaTools->addProductImpression($homeFeaturedProducts) . $gaTools->addProductClick($homeFeaturedProducts);`
`66`	`66`	`}`
`67`	`67`
`68`		`- $this->js_state = 1;`
	`68`	`+ $this->module->js_state = 1;`
`69`	`69`
`70`	`70`	`return $gaTagHandler->generate(`
`71`	`71`	`$gaTools->filter($gaScripts, $this->module->filterable)`
Original file line number	Diff line number	Diff line change
`@@ -92,6 +92,8 @@ public function run()`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`	`}`
	`95`	`+`
	`96`	`+ return '';`
`95`	`97`	`}`
`96`	`98`
`97`	`99`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public function findDataByCartIdAndShopId($cartId, $shopId)`
`47`	`47`	`*`
`48`	`48`	`* @param int $cartId`
`49`	`49`	`* @param int $shopId`
`50`		`- * @param array $data`
	`50`	`+ * @param string $data`
`51`	`51`	`*`
`52`	`52`	`* @return bool`
`53`	`53`	`*/`
`@@ -66,7 +66,7 @@ public function addNewRow($cartId, $shopId, $data)`
`66`	`66`	`* @param int $cartId`
`67`	`67`	`* @param int $shopId`
`68`	`68`	`*`
`69`		`- * @return void`
	`69`	`+ * @return bool`
`70`	`70`	`*/`
`71`	`71`	`public function deleteRow($cartId, $shopId)`
`72`	`72`	`{`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ public function findAllByShopIdAndDateAdd($shopId)`
`61`	`61`	`* addNewRow`
`62`	`62`	`*`
`63`	`63`	`* @param array $data`
`64`		`- * @param \Db $type`
	`64`	`+ * @param int $type`
`65`	`65`	`*`
`66`	`66`	`* @return bool`
`67`	`67`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function wrapProductList($products, $extras = [], $full = false)`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`foreach ($products as $index => $product) {`
`54`		`- if ($product instanceof Product) {`
	`54`	`+ if ($product instanceof \Product) {`
`55`	`55`	`$product = (array) $product;`
`56`	`56`	`}`
`57`	`57`