Added return for command classes, #PG-2642

matomo-org · Mar 16, 2023 · a0cec26 · a0cec26
1 parent f93e0aa
commit a0cec26
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 12 deletions.
diff --git a/Commands/AnonymizeLog.php b/Commands/AnonymizeLog.php
@@ -39,6 +39,12 @@ protected function configure()
         $this->addOption('pluginname', null, InputOption::VALUE_REQUIRED, 'If defined, the log file will be placed in the specified plugin instead of the VisitorGenerator plugin', 'VisitorGenerator');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $file    = $this->getPathToFile($input);
@@ -60,7 +66,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $target = $this->buildTargetFileName($plugin, $file);
         $this->saveFile($output, $target, $anonymized);
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function getReplace(InputInterface $input)

diff --git a/Commands/GenerateAnnotation.php b/Commands/GenerateAnnotation.php
@@ -26,6 +26,12 @@ protected function configure()
         $this->addOption('idsite', null, InputOption::VALUE_REQUIRED, 'Defines the site the goals should be generated for');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $idSite = (int) $input->getOption('idsite');
@@ -41,7 +47,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->writeSuccessMessage($output, array('1 Annotation for today generated'));
 
-        return 0;
+        return self::SUCCESS;
     }
 
 }
diff --git a/Commands/GenerateGoals.php b/Commands/GenerateGoals.php
@@ -26,6 +26,12 @@ protected function configure()
         $this->addOption('idsite', null, InputOption::VALUE_REQUIRED, 'Defines the site the goals should be generated for');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $idSite = (int) $input->getOption('idsite');
@@ -43,7 +49,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             sprintf('idsite=%d, %d goals generated (idgoal from %d to %d)', $idSite, count($goalIds), reset($goalIds), end($goalIds))
         ));
 
-        return 0;
+        return self::SUCCESS;
     }
 
 }
diff --git a/Commands/GenerateLiveVisits.php b/Commands/GenerateLiveVisits.php
@@ -44,6 +44,12 @@ protected function configure()
             . 'command continuously or a cron, this should be used, since the generated token auth will expire after 24 hours.');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $piwikUrl = $input->getOption('custom-matomo-url');
@@ -69,14 +75,14 @@ protected function execute(InputInterface $input, OutputInterface $output)
             list($count, $nextWaitTime) = $generateLiveVisits->tick();
             if ($count === null) {
                 $output->writeln("Found no logs to track for day of month / time of day, exiting.");
-                return 0;
+                return self::SUCCESS;
             }
 
             $output->writeln("  tracked $count actions.");
 
             if ($nextWaitTime === null) {
                 $output->writeln("Out of logs, exiting.");
-                return 0;
+                return self::SUCCESS;
             }
 
             // nextWaitTime can be large if the next visit happens in an hour. no sense in
@@ -85,7 +91,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 && (time() + $nextWaitTime) - $startTime > $stopAfter
             ) {
                 $output->writeln("$stopAfter seconds reached, exiting.");
-                return 0;
+                return self::SUCCESS;
             }
 
             $output->writeln("  sleeping {$nextWaitTime}s.");
@@ -95,11 +101,11 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 && time() - $startTime > $stopAfter
             ) {
                 $output->writeln("$stopAfter seconds reached, exiting.");
-                return 0;
+                return self::SUCCESS;
             }
         }
 
-        return 0; // should never occur
+        return self::SUCCESS; // should never occur
     }
 
     private function getPostiveIntegerOption(InputInterface $input, $optionName)

diff --git a/Commands/GenerateUsers.php b/Commands/GenerateUsers.php
@@ -25,6 +25,12 @@ protected function configure()
         $this->addOption('limit', null, InputOption::VALUE_REQUIRED, 'Defines how many users should be generated', 10);
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $limit = $input->getOption('limit');
@@ -36,7 +42,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->writeSuccessMessage($output, array(count($userLogins) . ' Users generated'));
 
-        return 0;
+        return self::SUCCESS;
     }
 
 }
diff --git a/Commands/GenerateVisits.php b/Commands/GenerateVisits.php
@@ -46,6 +46,12 @@ protected function configure()
         $this->addOption('non-profilable', null, InputOption::VALUE_NONE, "If supplied, tracks data without visitor IDs so it will be considered 'not profilable'.");
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->timeout =  $input->getOption('timeout');
@@ -97,7 +103,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             round($nbActionsTotal / $timer->getTime(), 0) . ' requests per second'
         ));
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function getLimitFakeVisits(InputInterface $input)

diff --git a/Commands/GenerateWebsites.php b/Commands/GenerateWebsites.php
@@ -25,6 +25,12 @@ protected function configure()
         $this->addOption('limit', null, InputOption::VALUE_REQUIRED, 'Defines how many websites should be generated', 10);
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $limit = $input->getOption('limit');
@@ -38,7 +44,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             sprintf('%d Websites generated (idsite from %d to %d)', count($siteIds), reset($siteIds), end($siteIds))
         ));
 
-        return 0;
+        return self::SUCCESS;
     }
 
 }
diff --git a/Commands/ShortenLog.php b/Commands/ShortenLog.php
@@ -37,6 +37,12 @@ protected function configure()
         $this->addOption('force-keep', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Forces to keep a log line if the given terms is present.');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     */
+
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $file      = $this->getPathToFile($input);
@@ -68,7 +74,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         echo $shortened;
 
-        return 0;
+        return self::SUCCESS;
     }
 
     private function containsTerm($line, $terms)