all commands return void

mirko-pagliai · mirko-pagliai · commit 9627c42306a2 · 2021-03-02T17:46:26.000+01:00
diff --git a/src/Command/DeleteAllCommand.php b/src/Command/DeleteAllCommand.php
@@ -40,28 +40,25 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Deletes all backup files
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#delete_all
      * @uses \DatabaseBackup\Utility\BackupManager::deleteAll()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
-        $files = (new BackupManager())->deleteAll();
-
+        $files = BackupManager::deleteAll();
         if (!$files) {
             $io->verbose(__d('database_backup', 'No backup has been deleted'));
 
-            return null;
+            return;
         }
 
         foreach ($files as $file) {
             $io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', $this->Filesystem->rtr($file)));
         }
 
         $io->success(__d('database_backup', 'Deleted backup files: {0}', count($files)));
-
-        return null;
     }
 }
diff --git a/src/Command/ExportCommand.php b/src/Command/ExportCommand.php
@@ -68,15 +68,16 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * This command uses `RotateCommand` and `SendCommand`.
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#export
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Command\RotateCommand::execute()
      * @uses \DatabaseBackup\Command\SendCommand::execute()
      * @uses \DatabaseBackup\Utility\BackupExport::compression()
      * @uses \DatabaseBackup\Utility\BackupExport::export()
      * @uses \DatabaseBackup\Utility\BackupExport::filename()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
@@ -120,7 +121,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }
diff --git a/src/Command/ImportCommand.php b/src/Command/ImportCommand.php
@@ -45,12 +45,13 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Imports a database backup
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#import
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Utility\BackupImport::filename()
      * @uses \DatabaseBackup\Utility\BackupImport::import()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
@@ -61,7 +62,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }
diff --git a/src/Command/IndexCommand.php b/src/Command/IndexCommand.php
@@ -42,20 +42,19 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Lists database backups
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#index
      * @uses \DatabaseBackup\Utility\BackupManager::index()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
         //Gets all backups
-        $backups = (new BackupManager())->index();
+        $backups = BackupManager::index();
         $io->out(__d('database_backup', 'Backup files found: {0}', $backups->count()));
-
         if ($backups->isEmpty()) {
-            return null;
+            return;
         }
 
         $headers = [
@@ -72,7 +71,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
                 ->toArray();
         });
         $io->helper('table')->output(array_merge([$headers], $cells->toList()));
-
-        return null;
     }
 }
diff --git a/src/Command/RotateCommand.php b/src/Command/RotateCommand.php
@@ -48,11 +48,12 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      *  delete all backups that are older. By default, no backup will be deleted
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#rotate
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Utility\BackupManager::rotate()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
@@ -63,7 +64,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             if (!$files) {
                 $io->verbose(__d('database_backup', 'No backup has been deleted'));
 
-                return null;
+                return;
             }
 
             foreach ($files as $file) {
@@ -75,7 +76,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }
diff --git a/src/Command/SendCommand.php b/src/Command/SendCommand.php
@@ -51,11 +51,12 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
      * Sends a backup file via email
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      * @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#send
+     * @throws \Cake\Console\Exception\StopException
      * @uses \DatabaseBackup\Utility\BackupManager::send()
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         parent::execute($args, $io);
 
@@ -66,7 +67,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int
             $io->error($e->getMessage());
             $this->abort();
         }
-
-        return null;
     }
 }
diff --git a/src/Console/Command.php b/src/Console/Command.php
@@ -45,16 +45,14 @@ public function __construct()
      * Implement this method with your command's logic
      * @param \Cake\Console\Arguments $args The command arguments
      * @param \Cake\Console\ConsoleIo $io The console io
-     * @return int|null The exit code or null for success
+     * @return void
      */
-    public function execute(Arguments $args, ConsoleIo $io): ?int
+    public function execute(Arguments $args, ConsoleIo $io): void
     {
         $config = $this->getConnection()->config();
 
         $io->out(__d('database_backup', 'Connection: {0}', $config['name']));
         $io->out(__d('database_backup', 'Driver: {0}', get_class_short_name($this->getConnection()->getDriver())));
         $io->hr();
-
-        return null;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -40,28 +40,25 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption`
`40`	`40`	`* Deletes all backup files`
`41`	`41`	`* @param \Cake\Console\Arguments $args The command arguments`
`42`	`42`	`* @param \Cake\Console\ConsoleIo $io The console io`
`43`		`- * @return int\|null The exit code or null for success`
	`43`	`+ * @return void`
`44`	`44`	`* @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#delete_all`
`45`	`45`	`* @uses \DatabaseBackup\Utility\BackupManager::deleteAll()`
`46`	`46`	`*/`
`47`		`- public function execute(Arguments $args, ConsoleIo $io): ?int`
	`47`	`+ public function execute(Arguments $args, ConsoleIo $io): void`
`48`	`48`	`{`
`49`	`49`	`parent::execute($args, $io);`
`50`	`50`
`51`		`- $files = (new BackupManager())->deleteAll();`
`52`		`-`
	`51`	`+ $files = BackupManager::deleteAll();`
`53`	`52`	`if (!$files) {`
`54`	`53`	`$io->verbose(__d('database_backup', 'No backup has been deleted'));`
`55`	`54`
`56`		`- return null;`
	`55`	`+ return;`
`57`	`56`	`}`
`58`	`57`
`59`	`58`	`foreach ($files as $file) {`
`60`	`59`	$io->verbose(__d('database_backup', 'Backup `{0}` has been deleted', $this->Filesystem->rtr($file)));
`61`	`60`	`}`
`62`	`61`
`63`	`62`	`$io->success(__d('database_backup', 'Deleted backup files: {0}', count($files)));`
`64`		`-`
`65`		`- return null;`
`66`	`63`	`}`
`67`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,12 +45,13 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption`
`45`	`45`	`* Imports a database backup`
`46`	`46`	`* @param \Cake\Console\Arguments $args The command arguments`
`47`	`47`	`* @param \Cake\Console\ConsoleIo $io The console io`
`48`		`- * @return int\|null The exit code or null for success`
	`48`	`+ * @return void`
`49`	`49`	`* @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#import`
	`50`	`+ * @throws \Cake\Console\Exception\StopException`
`50`	`51`	`* @uses \DatabaseBackup\Utility\BackupImport::filename()`
`51`	`52`	`* @uses \DatabaseBackup\Utility\BackupImport::import()`
`52`	`53`	`*/`
`53`		`- public function execute(Arguments $args, ConsoleIo $io): ?int`
	`54`	`+ public function execute(Arguments $args, ConsoleIo $io): void`
`54`	`55`	`{`
`55`	`56`	`parent::execute($args, $io);`
`56`	`57`
`@@ -61,7 +62,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int`
`61`	`62`	`$io->error($e->getMessage());`
`62`	`63`	`$this->abort();`
`63`	`64`	`}`
`64`		`-`
`65`		`- return null;`
`66`	`65`	`}`
`67`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,11 +48,12 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption`
`48`	`48`	`* delete all backups that are older. By default, no backup will be deleted`
`49`	`49`	`* @param \Cake\Console\Arguments $args The command arguments`
`50`	`50`	`* @param \Cake\Console\ConsoleIo $io The console io`
`51`		`- * @return int\|null The exit code or null for success`
	`51`	`+ * @return void`
`52`	`52`	`* @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#rotate`
	`53`	`+ * @throws \Cake\Console\Exception\StopException`
`53`	`54`	`* @uses \DatabaseBackup\Utility\BackupManager::rotate()`
`54`	`55`	`*/`
`55`		`- public function execute(Arguments $args, ConsoleIo $io): ?int`
	`56`	`+ public function execute(Arguments $args, ConsoleIo $io): void`
`56`	`57`	`{`
`57`	`58`	`parent::execute($args, $io);`
`58`	`59`
`@@ -63,7 +64,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int`
`63`	`64`	`if (!$files) {`
`64`	`65`	`$io->verbose(__d('database_backup', 'No backup has been deleted'));`
`65`	`66`
`66`		`- return null;`
	`67`	`+ return;`
`67`	`68`	`}`
`68`	`69`
`69`	`70`	`foreach ($files as $file) {`
`@@ -75,7 +76,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int`
`75`	`76`	`$io->error($e->getMessage());`
`76`	`77`	`$this->abort();`
`77`	`78`	`}`
`78`		`-`
`79`		`- return null;`
`80`	`79`	`}`
`81`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,11 +51,12 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption`
`51`	`51`	`* Sends a backup file via email`
`52`	`52`	`* @param \Cake\Console\Arguments $args The command arguments`
`53`	`53`	`* @param \Cake\Console\ConsoleIo $io The console io`
`54`		`- * @return int\|null The exit code or null for success`
	`54`	`+ * @return void`
`55`	`55`	`* @see https://github.com/mirko-pagliai/cakephp-database-backup/wiki/How-to-use-the-BackupShell#send`
	`56`	`+ * @throws \Cake\Console\Exception\StopException`
`56`	`57`	`* @uses \DatabaseBackup\Utility\BackupManager::send()`
`57`	`58`	`*/`
`58`		`- public function execute(Arguments $args, ConsoleIo $io): ?int`
	`59`	`+ public function execute(Arguments $args, ConsoleIo $io): void`
`59`	`60`	`{`
`60`	`61`	`parent::execute($args, $io);`
`61`	`62`
`@@ -66,7 +67,5 @@ public function execute(Arguments $args, ConsoleIo $io): ?int`
`66`	`67`	`$io->error($e->getMessage());`
`67`	`68`	`$this->abort();`
`68`	`69`	`}`
`69`		`-`
`70`		`- return null;`
`71`	`70`	`}`
`72`	`71`	`}`
Original file line number	Diff line number	Diff line change
`@@ -45,16 +45,14 @@ public function __construct()`
`45`	`45`	`* Implement this method with your command's logic`
`46`	`46`	`* @param \Cake\Console\Arguments $args The command arguments`
`47`	`47`	`* @param \Cake\Console\ConsoleIo $io The console io`
`48`		`- * @return int\|null The exit code or null for success`
	`48`	`+ * @return void`
`49`	`49`	`*/`
`50`		`- public function execute(Arguments $args, ConsoleIo $io): ?int`
	`50`	`+ public function execute(Arguments $args, ConsoleIo $io): void`
`51`	`51`	`{`
`52`	`52`	`$config = $this->getConnection()->config();`
`53`	`53`
`54`	`54`	`$io->out(__d('database_backup', 'Connection: {0}', $config['name']));`
`55`	`55`	`$io->out(__d('database_backup', 'Driver: {0}', get_class_short_name($this->getConnection()->getDriver())));`
`56`	`56`	`$io->hr();`
`57`		`-`
`58`		`- return null;`
`59`	`57`	`}`
`60`	`58`	`}`