#1259 Use Symfony Console Command constants

OPUS4 · Feb 6, 2025 · 2decc4e · 2decc4e
1 parent 81ce7b9
commit 2decc4e
Show file tree

Hide file tree

Showing 12 changed files with 31 additions and 31 deletions.
diff --git a/library/Application/Console/Collection/CopyCommand.php b/library/Application/Console/Collection/CopyCommand.php
@@ -59,12 +59,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if ($sourceCol === null) {
             $output->writeln('Source collection needs to be specified.');
-            return 0;
+            return self::FAILURE;
         }
 
         if ($destCol === null) {
             $output->writeln('Destination collection needs to be specified.');
-            return 0;
+            return self::FAILURE;
         }
 
         $sourceId = $sourceCol->getId();
@@ -79,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('');
             $output->writeln('  "' . $sourceCol->getDisplayName() . '"');
             $output->writeln('');
-            return 0;
+            return self::SUCCESS;
         }
 
         $destDocuments = $destCol->getDocumentIds();
@@ -88,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if ($moveCount === 0) {
             $output->writeln("Destination collection already contains all the documents (${sourceCount}) of source collection.");
-            return 0;
+            return self::SUCCESS;
         }
 
         $output->writeln("Copy documents (${moveCount}) from source collection (ID = ${sourceId})");
@@ -116,6 +116,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('Copying cancelled');
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Collection/MoveCommand.php b/library/Application/Console/Collection/MoveCommand.php
@@ -59,12 +59,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if ($sourceCol === null) {
             $output->writeln('Source collection needs to be specified.');
-            return 0;
+            return self::FAILURE;
         }
 
         if ($destCol === null) {
             $output->writeln('Destination collection needs to be specified.');
-            return 0;
+            return self::FAILURE;
         }
 
         $sourceId = $sourceCol->getId();
@@ -79,7 +79,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('');
             $output->writeln('  "' . $sourceCol->getDisplayName() . '"');
             $output->writeln('');
-            return 0;
+            return self::SUCCESS;
         }
 
         $output->writeln("Move documents (${sourceCount}) from source collection (ID = ${sourceId})");
@@ -107,6 +107,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('Moving cancelled');
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Collection/RemoveCommand.php b/library/Application/Console/Collection/RemoveCommand.php
@@ -201,7 +201,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if ($targetCol === null) {
             $output->writeln('Collection must be specified');
-            return 0;
+            return self::FAILURE;
         }
 
         $targetId = $targetCol->getId();
@@ -214,7 +214,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('');
             $output->writeln('  "' . $targetCol->getDisplayName() . '"');
             $output->writeln('');
-            return 0;
+            return self::FAILURE;
         }
 
         $removeDocuments = null;
@@ -235,7 +235,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $output->writeln('');
                 $output->writeln('  "' . $filterCol->getDisplayName() . '"');
                 $output->writeln('');
-                return 0;
+                return self::FAILURE;
             }
 
             $removeDocuments = array_intersect($filterDocuments, $targetDocuments);
@@ -246,11 +246,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $output->writeln('');
                 $output->writeln('  "' . $filterCol->getDisplayName() . '"');
                 $output->writeln('');
-                $output->writeln("is present in the target collection (ID= ${targetId})");
+                $output->writeln("are present in the target collection (ID= ${targetId})");
                 $output->writeln('');
                 $output->writeln('  "' . $targetCol->getDisplayName() . '"');
                 $output->writeln('');
-                return 0;
+                return self::FAILURE;
             }
 
             $output->writeln("Remove documents (${filterCount}) in collection (ID = ${filterId})");
@@ -279,6 +279,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('Removing cancelled');
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Console/ConsoleCommand.php b/library/Application/Console/Console/ConsoleCommand.php
@@ -66,10 +66,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $output->writeln('Caught exception ' . get_class($e) . ': ' . $e->getMessage());
                 $output->writeln($e->getTraceAsString());
 
-                return Command::FAILURE;
+                return self::FAILURE;
             }
         }
 
-        return Command::SUCCESS;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Console/ExecCommand.php b/library/Application/Console/Console/ExecCommand.php
@@ -86,10 +86,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $output->writeln('Caught exception ' . get_class($e) . ': ' . $e->getMessage());
                 $output->writeln($e->getTraceAsString());
 
-                return Command::FAILURE;
+                return self::FAILURE;
             }
         }
 
-        return $successfulIncludes > 0 ? Command::SUCCESS : Command::FAILURE;
+        return $successfulIncludes > 0 ? self::SUCCESS : self::FAILURE;
     }
 }
diff --git a/library/Application/Console/Debug/DocumentXmlCommand.php b/library/Application/Console/Debug/DocumentXmlCommand.php
@@ -78,6 +78,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $output->write($xml->saveXml());
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Document/DeleteCommand.php b/library/Application/Console/Document/DeleteCommand.php
@@ -136,7 +136,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('Deletion cancelled');
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/library/Application/Console/Document/DiffCommand.php b/library/Application/Console/Document/DiffCommand.php
@@ -124,7 +124,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $diff->diff($docIds);
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/library/Application/Console/Document/DuplicatesCommand.php b/library/Application/Console/Document/DuplicatesCommand.php
@@ -177,7 +177,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $output->writeln('No DOI values found');
         }
 
-        return 0;
+        return self::SUCCESS;
     }
 
     /**

diff --git a/library/Application/Console/Task/InfoCommand.php b/library/Application/Console/Task/InfoCommand.php
@@ -72,7 +72,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if (empty($taskConfigurations)) {
             $output->writeln('<fg=red>There are no tasks configured</>');
-            return Command::FAILURE;
+            return self::FAILURE;
         }
 
         if (empty($taskName)) {
@@ -98,7 +98,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $taskConfig = $taskManager->getTaskConfig($taskName);
         if (! $taskConfig) {
             $output->writeln('Task not found: <fg=red>' . $taskName . '</>');
-            return Command::FAILURE;
+            return self::FAILURE;
         }
 
         // show
@@ -132,6 +132,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             ->setStyle('compact')
             ->render();
 
-        return Command::SUCCESS;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Task/ListCommand.php b/library/Application/Console/Task/ListCommand.php
@@ -90,6 +90,6 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $table->render();
 
-        return 0;
+        return self::SUCCESS;
     }
 }
diff --git a/library/Application/Console/Task/RunCommand.php b/library/Application/Console/Task/RunCommand.php
@@ -75,7 +75,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if (empty($taskConfigurations)) {
             $output->writeln('<fg=red>There are no tasks to run</>');
-            return Command::FAILURE;
+            return self::FAILURE;
         }
 
         if (empty($taskName)) {
@@ -101,22 +101,22 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $taskConfig = $taskManager->getTaskConfig($taskName);
         if (! $taskConfig) {
             $output->writeln('Task not found: <fg=red>' . $taskName . '</>');
-            return Command::FAILURE;
+            return self::FAILURE;
         }
 
         if (! $taskManager->isValidTaskClass($taskConfig->getClass())) {
             $output->writeln(
                 'Invalid task class <fg=red>' . $taskConfig->getClass()
                 . '</> for task <fg=red>' . $taskName . '</>'
             );
-            return Command::FAILURE;
+            return self::FAILURE;
         }
 
         $taskRunner       = new TaskRunner();
         $taskRunnerLogger = $taskRunner->getTaskLogger();
         $taskRunnerLogger->info('CLI triggered run: "' . $taskName . '"');
         $taskRunner->runTask($taskName);
 
-        return Command::SUCCESS;
+        return self::SUCCESS;
     }
 }
-Original file line number
+Diff line change
@@ Expand Up @@
                 $output->writeln('Deletion cancelled');
             }
-            return 0;
+            return self::SUCCESS;
         }
         /**
@@ Expand Down @@