Moved helpers to AbstractMagentoCommand (#1454)

netz98 · Aug 5, 2024 · 9e55ff2 · 9e55ff2
1 parent ee28176
commit 9e55ff2
Show file tree

Hide file tree

Showing 68 changed files with 126 additions and 259 deletions.
diff --git a/src/N98/Magento/Command/AbstractMagentoCommand.php b/src/N98/Magento/Command/AbstractMagentoCommand.php
@@ -14,10 +14,12 @@
 use N98\Magento\Application;
 use N98\Magento\Command\SubCommand\ConfigBag;
 use N98\Magento\Command\SubCommand\SubCommandFactory;
+use N98\Util\Console\Helper\DatabaseHelper;
 use N98\Util\Console\Helper\IoHelper;
 use N98\Util\Console\Helper\MagentoHelper;
 use N98\Util\Console\Helper\ParameterHelper;
 use N98\Util\Console\Helper\Table\Renderer\RendererFactory;
+use N98\Util\Console\Helper\TableHelper;
 use N98\Util\OperatingSystem;
 use N98\Util\StringTyped;
 use RuntimeException;
@@ -554,8 +556,7 @@ protected function chooseInstallationFolder(InputInterface $input, OutputInterfa
         if (($installationFolder = $input->getOption('installationFolder')) == null) {
             $defaultFolder = './magento';
 
-            /* @var QuestionHelper $dialog */
-            $dialog = $this->getHelper('question');
+            $dialog = $this->getQuestionHelper();
             $questionObj = new Question(
                 '<question>Enter installation folder:</question> [<comment>' . $defaultFolder . '</comment>]',
                 $defaultFolder
@@ -595,8 +596,7 @@ protected function getOrAskForArgument($argument, InputInterface $input, OutputI
         if ($inputArgument === null) {
             $message = $this->getArgumentMessage($argument, $message);
 
-            /* @var QuestionHelper $dialog */
-            $dialog = $this->getHelper('question');
+            $dialog = $this->getQuestionHelper();
             return $dialog->ask($input, $output, new Question($message));
         }
 
@@ -620,8 +620,7 @@ protected function askForArrayEntry(array $entries, InputInterface $input, Outpu
             return $typeInput;
         };
 
-        /* @var QuestionHelper $dialog */
-        $dialog = $this->getHelper('question');
+        $dialog = $this->getQuestionHelper();
         $question = new ChoiceQuestion(
             "<question>{$question}</question>",
             $entries
@@ -683,7 +682,7 @@ protected function createSubCommandFactory(
      *
      * @return $this
      */
-    public function addFormatOption(): AbstractMagentoCommand
+    public function addFormatOption(): self
     {
         $this->addOption(
             'format',
@@ -694,18 +693,43 @@ public function addFormatOption(): AbstractMagentoCommand
         return $this;
     }
 
+    /**
+     * @return DatabaseHelper
+     */
+    public function getDatabaseHelper(): DatabaseHelper
+    {
+        return $this->getHelper('database');
+    }
+
+    /**
+     * @return IoHelper
+     */
     public function getIoHelper(): IoHelper
     {
         return $this->getHelper('io');
     }
 
+    /**
+     * @return ParameterHelper
+     */
     public function getParameterHelper(): ParameterHelper
     {
         return $this->getHelper('parameter');
     }
 
+    /**
+     * @return QuestionHelper
+     */
     public function getQuestionHelper(): QuestionHelper
     {
         return $this->getHelper('question');
     }
+
+    /**
+     * @return TableHelper
+     */
+    public function getTableHelper(): TableHelper
+    {
+        return $this->getHelper('table');
+    }
 }
diff --git a/src/N98/Magento/Command/Admin/User/ChangePasswordCommand.php b/src/N98/Magento/Command/Admin/User/ChangePasswordCommand.php
@@ -4,7 +4,6 @@
 
 use Exception;
 use RuntimeException;
-use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -40,8 +39,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return 0;
         }
 
-        /* @var QuestionHelper $dialog */
-        $dialog = $this->getHelper('question');
+        $dialog = $this->getQuestionHelper();
 
         // Username
         if (($username = $input->getArgument('username')) == null) {

diff --git a/src/N98/Magento/Command/Admin/User/CreateUserCommand.php b/src/N98/Magento/Command/Admin/User/CreateUserCommand.php
@@ -42,8 +42,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $username = $this->getOrAskForArgument('username', $input, $output);
             $email = $this->getOrAskForArgument('email', $input, $output);
             if (($password = $input->getArgument('password')) === null) {
-                /* @var QuestionHelper $dialog */
-                $dialog = $this->getHelper('question');
+                $dialog = $this->getQuestionHelper();
                 $question = new Question('<question>Password:</question> ');
                 $question->setHidden(true);
                 $password = $dialog->ask($input, $output, $question);

diff --git a/src/N98/Magento/Command/Admin/User/DeleteUserCommand.php b/src/N98/Magento/Command/Admin/User/DeleteUserCommand.php
@@ -43,8 +43,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return 0;
         }
 
-        /* @var QuestionHelper $dialog */
-        $dialog = $this->getHelper('question');
+        $dialog = $this->getQuestionHelper();
 
         // Username
         $id = $this->getOrAskForArgument('id', $input, $output, 'Username or Email');

diff --git a/src/N98/Magento/Command/Admin/User/ListCommand.php b/src/N98/Magento/Command/Admin/User/ListCommand.php
@@ -2,7 +2,6 @@
 
 namespace N98\Magento\Command\Admin\User;
 
-use N98\Util\Console\Helper\TableHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -43,8 +42,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $table[] = [$user->getId(), $user->getUsername(), $user->getEmail(), $user->getIsActive() ? 'active' : 'inactive'];
         }
 
-        /* @var TableHelper $tableHelper */
-        $tableHelper = $this->getHelper('table');
+        $tableHelper = $this->getTableHelper();
         $tableHelper
             ->setHeaders(['id', 'username', 'email', 'status'])
             ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Cache/ListCommand.php b/src/N98/Magento/Command/Cache/ListCommand.php
@@ -2,7 +2,6 @@
 
 namespace N98\Magento\Command\Cache;
 
-use N98\Util\Console\Helper\TableHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -40,8 +39,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $table[] = [$cacheCode, $cacheInfo['status'] ? 'enabled' : 'disabled'];
         }
 
-        /* @var TableHelper $tableHelper */
-        $tableHelper = $this->getHelper('table');
+        $tableHelper = $this->getTableHelper();
         $tableHelper
             ->setHeaders(['code', 'status'])
             ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Cache/ReportCommand.php b/src/N98/Magento/Command/Cache/ReportCommand.php
@@ -4,7 +4,6 @@
 
 use Enterprise_PageCache_Model_Cache;
 use Mage;
-use N98\Util\Console\Helper\TableHelper;
 use RuntimeException;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -98,8 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $headers[] = 'TAGS';
         }
 
-        /* @var TableHelper $tableHelper */
-        $tableHelper = $this->getHelper('table');
+        $tableHelper = $this->getTableHelper();
         $tableHelper
             ->setHeaders($headers)
             ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Category/Create/DummyCommand.php b/src/N98/Magento/Command/Category/Create/DummyCommand.php
@@ -6,7 +6,6 @@
 use Mage_Catalog_Model_Category;
 use N98\Magento\Command\AbstractMagentoCommand;
 use RuntimeException;
-use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -138,8 +137,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
      */
     private function askForArguments($input, $output)
     {
-        /* @var QuestionHelper $dialog */
-        $dialog = $this->getHelper('question');
+        $dialog = $this->getQuestionHelper();
         $_argument = [];
 
         // Store ID

diff --git a/src/N98/Magento/Command/Cms/Block/ListCommand.php b/src/N98/Magento/Command/Cms/Block/ListCommand.php
@@ -3,7 +3,6 @@
 namespace N98\Magento\Command\Cms\Block;
 
 use N98\Magento\Command\AbstractMagentoCommand;
-use N98\Util\Console\Helper\TableHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -63,8 +62,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $table[] = [$cmsBlock->getData('block_id'), $cmsBlock->getData('identifier'), $cmsBlock->getData('title'), $cmsBlock->getData('is_active') ? 'active' : 'inactive', $storeIds];
         }
 
-        /* @var TableHelper $tableHelper */
-        $tableHelper = $this->getHelper('table');
+        $tableHelper = $this->getTableHelper();
         $tableHelper
             ->setHeaders(['block_id', 'identifier', 'title', 'is_active', 'store_ids'])
             ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Config/DeleteCommand.php b/src/N98/Magento/Command/Config/DeleteCommand.php
@@ -3,7 +3,6 @@
 namespace N98\Magento\Command\Config;
 
 use Mage;
-use N98\Util\Console\Helper\TableHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -84,8 +83,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if (count($deleted) > 0) {
-            /* @var TableHelper $tableHelper */
-            $tableHelper = $this->getHelper('table');
+            $tableHelper = $this->getTableHelper();
             $tableHelper
                 ->setHeaders(['Deleted Path', 'Scope', 'Scope-ID'])
                 ->setRows($deleted)

diff --git a/src/N98/Magento/Command/Config/GetCommand.php b/src/N98/Magento/Command/Config/GetCommand.php
@@ -2,7 +2,6 @@
 
 namespace N98\Magento\Command\Config;
 
-use N98\Util\Console\Helper\TableHelper;
 use Path;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -138,8 +137,7 @@ protected function renderAsTable(OutputInterface $output, $table, $format)
             $formattedTable[] = [$row['path'], $row['scope'], $row['scope_id'], $this->renderTableValue($row['value'], $format)];
         }
 
-        /* @var TableHelper $tableHelper */
-        $tableHelper = $this->getHelper('table');
+        $tableHelper = $this->getTableHelper();
         $tableHelper
             ->setHeaders([Path::class, 'Scope', 'Scope-ID', 'Value'])
             ->setRows($formattedTable)

diff --git a/src/N98/Magento/Command/Customer/ChangePasswordCommand.php b/src/N98/Magento/Command/Customer/ChangePasswordCommand.php
@@ -3,9 +3,7 @@
 namespace N98\Magento\Command\Customer;
 
 use Exception;
-use N98\Util\Console\Helper\ParameterHelper;
 use RuntimeException;
-use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -54,15 +52,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         // Password
         if (($password = $input->getArgument('password')) == null) {
-            /* @var QuestionHelper $dialog */
-            $dialog = $this->getHelper('question');
+            $dialog = $this->getQuestionHelper();
             $question = new Question('<question>Password:</question> ');
             $question->setHidden(true);
             $password = $dialog->ask($input, $output, $question);
         }
 
-        /** @var ParameterHelper $parameterHelper */
-        $parameterHelper = $this->getHelper('parameter');
+        $parameterHelper = $this->getParameterHelper();
 
         $email = $parameterHelper->askEmail($input, $output);
         $website = $parameterHelper->askWebsite($input, $output);

diff --git a/src/N98/Magento/Command/Customer/CreateCommand.php b/src/N98/Magento/Command/Customer/CreateCommand.php
@@ -2,9 +2,6 @@
 
 namespace N98\Magento\Command\Customer;
 
-use N98\Util\Console\Helper\ParameterHelper;
-use N98\Util\Console\Helper\TableHelper;
-use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -43,8 +40,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return 0;
         }
 
-        /* @var QuestionHelper $dialog */
-        $dialog = $this->getHelper('question');
+        $dialog = $this->getQuestionHelper();
 
         // Password
         if (($password = $input->getArgument('password')) == null) {
@@ -63,8 +59,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $lastname = $dialog->ask($input, $output, new Question('<question>Lastname:</question> '));
         }
 
-        /** @var ParameterHelper $parameterHelper */
-        $parameterHelper = $this->getHelper('parameter');
+        $parameterHelper = $this->getParameterHelper();
 
         // Email
         $email = $parameterHelper->askEmail($input, $output);
@@ -102,8 +97,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         if (!$outputPlain) {
-            /* @var TableHelper $tableHelper */
-            $tableHelper = $this->getHelper('table');
+            $tableHelper = $this->getTableHelper();
             $tableHelper
                 ->setHeaders(['email', 'password', 'firstname', 'lastname'])
                 ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Customer/CreateDummyCommand.php b/src/N98/Magento/Command/Customer/CreateDummyCommand.php
@@ -4,8 +4,6 @@
 
 use Faker\Factory;
 use Locale;
-use N98\Util\Console\Helper\ParameterHelper;
-use N98\Util\Console\Helper\TableHelper;
 use N98\Util\Faker\Provider\Internet;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -80,8 +78,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $faker = Factory::create($input->getArgument('locale'));
         $faker->addProvider(new Internet($faker));
 
-        /** @var ParameterHelper $parameterHelper */
-        $parameterHelper = $this->getHelper('parameter');
+        $parameterHelper = $this->getParameterHelper();
 
         $website = $parameterHelper->askWebsite($input, $output);
 
@@ -136,8 +133,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $res->commit();
 
         if (!$outputPlain) {
-            /* @var TableHelper $tableHelper */
-            $tableHelper = $this->getHelper('table');
+            $tableHelper = $this->getTableHelper();
             $tableHelper
                 ->setHeaders(['email', 'password', 'firstname', 'lastname'])
                 ->renderByFormat($output, $table, $input->getOption('format'));

diff --git a/src/N98/Magento/Command/Customer/DeleteCommand.php b/src/N98/Magento/Command/Customer/DeleteCommand.php
@@ -6,7 +6,6 @@
 use Mage_Customer_Model_Customer;
 use Mage_Customer_Model_Entity_Customer_Collection;
 use Mage_Customer_Model_Resource_Customer_Collection;
-use N98\Util\Console\Helper\ParameterHelper;
 use RuntimeException;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputArgument;
@@ -209,8 +208,7 @@ protected function getCustomer($id)
         /** @var \Mage_Customer_Model_Customer $customer */
         $customer = $this->getCustomerModel()->load($id);
         if (!$customer->getId()) {
-            /** @var ParameterHelper $parameterHelper */
-            $parameterHelper = $this->getHelper('parameter');
+            $parameterHelper = $this->getParameterHelper();
             $website = $parameterHelper->askWebsite($this->input, $this->output);
             $customer = $this->getCustomerModel()
                 ->setWebsiteId($website->getId())
@@ -279,7 +277,7 @@ public function validateInt($answer)
      * @param string $message
      * @param string $default [optional]
      *
-     * @return \Symfony\Component\Console\Question\Question
+     * @return Question
      */
     private function getQuestion($message, $default = null)
     {