#4 Add code quality tools and github worklow

Add php stan ( WIP )
friends-of-presta · Oct 29, 2021 · d75430f · d75430f
1 parent 28b4eab
commit d75430f
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 2 deletions.
diff --git a/classes/CronJobsForms.php b/classes/CronJobsForms.php
@@ -25,6 +25,10 @@ class CronJobsForms
 {
     protected static $module = false;
 
+    /**
+     * @param Module $module
+     * @return bool
+     */
     public static function init($module)
     {
         if (self::$module == false) {
@@ -34,6 +38,11 @@ public static function init($module)
         return self::$module;
     }
 
+    /**
+     * @param string $title
+     * @param false $update
+     * @return array[]
+     */
     public static function getJobForm($title = 'New cron task', $update = false)
     {
         $form = [
@@ -150,6 +159,9 @@ public static function getJobForm($title = 'New cron task', $update = false)
         return $form;
     }
 
+    /**
+     * @return array[]
+     */
     public static function getForm()
     {
         $form = [
@@ -182,6 +194,9 @@ public static function getForm()
         return [$form];
     }
 
+    /**
+     * @return array[]
+     */
     public static function getFormValues()
     {
         $token = Configuration::get('CRONJOBS_EXECUTION_TOKEN', null, 0, 0);
@@ -211,6 +226,9 @@ public static function getFormValues()
         ];
     }
 
+    /**
+     * @return array[]
+     */
     public static function getTasksList()
     {
         return [
@@ -226,6 +244,9 @@ public static function getTasksList()
         ];
     }
 
+    /**
+     * @return array[]
+     */
     public static function getNewJobFormValues()
     {
         return [
@@ -238,6 +259,9 @@ public static function getNewJobFormValues()
         ];
     }
 
+    /**
+     * @return array[]
+     */
     public static function getUpdateJobFormValues()
     {
         $id_shop = (int) Context::getContext()->shop->id;
@@ -267,6 +291,9 @@ public static function getUpdateJobFormValues()
         ];
     }
 
+    /**
+     * @return array|bool
+     */
     public static function getTasksListValues()
     {
         $id_shop = (int) Context::getContext()->shop->id;
@@ -326,6 +353,9 @@ public static function getTasksListValues()
         return $crons;
     }
 
+    /**
+     * @return array[]
+     */
     protected static function getHoursFormOptions()
     {
         $data = [['id' => '-1', 'name' => self::$module->l('Every hour', 'CronJobsForms')]];
@@ -337,6 +367,9 @@ protected static function getHoursFormOptions()
         return $data;
     }
 
+    /**
+     * @return array[]
+     */
     protected static function getDaysFormOptions()
     {
         $data = [['id' => '-1', 'name' => self::$module->l('Every day of the month', 'CronJobsForms')]];
@@ -348,6 +381,9 @@ protected static function getDaysFormOptions()
         return $data;
     }
 
+    /**
+     * @return array[]
+     */
     protected static function getMonthsFormOptions()
     {
         $data = [['id' => '-1', 'name' => self::$module->l('Every month', 'CronJobsForms')]];
@@ -359,6 +395,9 @@ protected static function getMonthsFormOptions()
         return $data;
     }
 
+    /**
+     * @return array[]
+     */
     protected static function getDaysofWeekFormOptions()
     {
         $data = [['id' => '-1', 'name' => self::$module->l('Every day of the week', 'CronJobsForms')]];

diff --git a/composer.json b/composer.json
@@ -17,14 +17,15 @@
   },
   "type": "prestashop-module",
   "require-dev": {
-    "prestashop/php-dev-tools": "^4.1"
+    "prestashop/php-dev-tools": "^4.1",
+    "phpstan/phpstan": "^0.12.99"
   },
   "scripts": {
     "cs-fixer": [
       "@php ./vendor/bin/php-cs-fixer fix"
     ],
     "header-stamp": [
-      "@php ./vendor/bin/header-stamp --exclude=\"vendor,translations\" --extensions=php --license=vendor/prestashop/header-stamp/assets/afl.txt"
+      "@php ./vendor/bin/header-stamp --exclude=\"vendor,translations\" --extensions=php --license=assets/afl.txt"
     ]
   }
 }
diff --git a/controllers/admin/AdminCronJobsController.php b/controllers/admin/AdminCronJobsController.php
@@ -32,6 +32,11 @@ public function __construct()
         exit;
     }
 
+    /**
+     * @return bool|ObjectModel|void
+     * @throws PrestaShopDatabaseException
+     * @throws PrestaShopException
+     */
     public function postProcess()
     {
         $this->module->sendCallback();
@@ -44,6 +49,11 @@ public function postProcess()
         ob_end_clean();
     }
 
+    /**
+     * @return void
+     * @throws PrestaShopDatabaseException
+     * @throws PrestaShopException
+     */
     protected function runModulesCrons()
     {
         $query = 'SELECT * FROM ' . _DB_PREFIX_ . bqSQL($this->module->name) . ' WHERE `active` = 1 AND `id_module` IS NOT NULL';
@@ -72,6 +82,10 @@ protected function runModulesCrons()
         }
     }
 
+    /**
+     * @return void
+     * @throws PrestaShopDatabaseException
+     */
     protected function runTasksCrons()
     {
         $query = 'SELECT * FROM ' . _DB_PREFIX_ . bqSQL($this->module->name) . ' WHERE `active` = 1 AND `id_module` IS NULL';
@@ -93,6 +107,10 @@ protected function runTasksCrons()
         }
     }
 
+    /**
+     * @param array $cron
+     * @return bool
+     */
     protected function shouldBeExecuted($cron)
     {
         $hour = ($cron['hour'] == -1) ? date('H') : $cron['hour'];

diff --git a/cronjobs.php b/cronjobs.php
@@ -237,6 +237,7 @@ public function getContent()
         $this->context->smarty->assign('form_infos', $this->_warnings);
         $this->context->smarty->assign('form_successes', $this->_successes);
 
+        $back_url='';
         if ((Tools::isSubmit('submitNewCronJob') || Tools::isSubmit('newcronjobs') || Tools::isSubmit('updatecronjobs')) &&
             ((isset($submit_cron) == false) || ($submit_cron === false))) {
             $back_url = $this->context->link->getAdminLink('AdminModules', false)

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,10 @@
+includes:
+  - %currentWorkingDirectory%/vendor/prestashop/php-dev-tools/phpstan/ps-module-extension.neon
+
+parameters:
+  paths:
+    - ./
+  excludes_analyse:
+    - vendor/
+  reportUnmatchedIgnoredErrors: false
+  level: 6
diff --git a/upgrade/upgrade-1.0.6.php b/upgrade/upgrade-1.0.6.php
@@ -21,6 +21,10 @@
     exit;
 }
 
+/**
+ * @param Module $module
+ * @return Module
+ */
 function upgrade_module_1_0_6($module)
 {
     $table_name = _DB_PREFIX_ . bqSQL($module->name);