Updated list commands

composer.json

@@ -13,7 +13,7 @@
         "magerun"
     ],
     "require": {
-        "php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0",
+        "php": "~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.3.0 || ~8.2.0 || ~8.4.0",
         "ext-json": "*",
         "ext-libxml": "*",
         "ext-pdo": "*",

src/N98/Magento/Command/AbstractMagentoCommand.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace N98\Magento\Command;
 
 use Composer\Composer;
@@ -39,6 +41,8 @@
  */
 abstract class AbstractMagentoCommand extends Command
 {
+    public const COMMAND_OPTION_FORMAT = 'format';
+
     /**
      * @var string
      */
@@ -69,6 +73,28 @@ abstract class AbstractMagentoCommand extends Command
      */
     protected $config;
 
+    /**
+     * @var array|null
+     */
+    protected ?array $data = null;
+
+    /**
+     * @var string
+     */
+    protected static string $noResultMessage = '';
+
+    /**
+     * @var bool
+     */
+    protected static bool $detectMagentoSilent = true;
+
+    protected function configure()
+    {
+        if ($this instanceof CommandWithFormatOption || $this instanceof CommandFormatable) {
+            $this->addFormatOption();
+        }
+    }
+
     /**
      * Initializes the command just after the input has been validated.
      *
@@ -83,11 +109,50 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         $this->checkDeprecatedAliases($input, $output);
     }
 
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        if ($this instanceof CommandFormatable) {
+            $this->detectMagento($output, static::$detectMagentoSilent);
+
+            $formatOption = $input->getOption(static::COMMAND_OPTION_FORMAT);
+
+            if ($formatOption === null) {
+                $this->writeSection($output, $this->getSectionTitle($input, $output));
+            }
+
+            if (!$this->initMagento()) {
+                return Command::FAILURE;
+            }
+
+            $data = $this->getListData($input, $output);
+            if ($formatOption === null && $data === []) {
+                if (static::$noResultMessage) {
+                    $output->writeln(sprintf(
+                        '<info>%s</info>',
+                        static::$noResultMessage
+                    ));
+                } else {
+                    $output->writeln(sprintf(
+                        '<info>No entry found for "%s" </info>',
+                        $this->getSectionTitle($input, $output)
+                    ));
+                }
+            }
+
+            $this->getTableHelper()
+                ->setHeaders($this->getListHeader($input, $output))
+                ->renderByFormat($output, $data, $input->getOption(self::COMMAND_OPTION_FORMAT));
+
+            return Command::SUCCESS;
+        }
+
+        return Command::INVALID;
+    }
+
     private function _initWebsites()
     {
         $this->_websiteCodeMap = [];
-        /** @var \Mage_Core_Model_Website[] $websites */
-        $websites = Mage::app()->getWebsites(false);
+        $websites = Mage::app()->getWebsites();
         foreach ($websites as $website) {
             $this->_websiteCodeMap[$website->getId()] = $website->getCode();
         }
@@ -638,7 +703,7 @@ protected function createSubCommandFactory(
     public function addFormatOption(): self
     {
         $this->addOption(
-            'format',
+            self::COMMAND_OPTION_FORMAT,
             null,
             InputOption::VALUE_OPTIONAL,
             'Output Format. One of [' . implode(',', RendererFactory::getFormats()) . ']'

src/N98/Magento/Command/Admin/User/AbstractAdminUserCommand.php

@@ -1,7 +1,13 @@
 <?php
 
+declare(strict_types=1);
+
 namespace N98\Magento\Command\Admin\User;
 
+use Mage;
+use Mage_Admin_Model_Roles;
+use Mage_Admin_Model_Rules;
+use Mage_Admin_Model_User;
 use N98\Magento\Command\AbstractMagentoCommand;
 
 /**
@@ -12,23 +18,23 @@
 abstract class AbstractAdminUserCommand extends AbstractMagentoCommand
 {
     /**
-     * @return \Mage_Core_Model_Abstract|\Mage_Admin_Model_User
+     * @return Mage_Admin_Model_User
      */
     protected function getUserModel()
     {
         return $this->_getModel('admin/user');
     }
 
     /**
-     * @return \Mage_Core_Model_Abstract
+     * @return Mage_Admin_Model_Roles
      */
     protected function getRoleModel()
     {
         return $this->_getModel('admin/roles');
     }
 
     /**
-     * @return \Mage_Core_Model_Abstract
+     * @return Mage_Admin_Model_Rules
      */
     protected function getRulesModel()
     {

src/N98/Magento/Command/Admin/User/ListCommand.php

@@ -1,51 +1,76 @@
 <?php
 
+declare(strict_types=1);
+
 namespace N98\Magento\Command\Admin\User;
 
+use Mage_Admin_Model_User;
+use N98\Magento\Command\CommandFormatable;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
+use function is_array;
+
 /**
  * List admin user password command
  *
  * @package N98\Magento\Command\Admin\User
  */
-class ListCommand extends AbstractAdminUserCommand
+class ListCommand extends AbstractAdminUserCommand implements CommandFormatable
 {
-    protected function configure()
+    /**
+     * @var string
+     */
+    protected static $defaultName = 'admin:user:list';
+
+    /**
+     * @var string
+     */
+    protected static $defaultDescription = 'List admin users.';
+
+    /**
+     * @var string
+     */
+    protected static string $noResultMessage = 'No admin users found.';
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getSectionTitle(InputInterface $input, OutputInterface $output): string
+    {
+        return 'Admin users';
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getListHeader(InputInterface $input, OutputInterface $output): array
     {
-        $this
-            ->setName('admin:user:list')
-            ->setDescription('List admin users.')
-            ->addFormatOption()
-        ;
+        return ['id', 'username', 'email', 'status'];
     }
 
     /**
-     * @param InputInterface $input
-     * @param OutputInterface $output
-     *
-     * @return int
+     * {@inheritDoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output): int
+    public function getListData(InputInterface $input, OutputInterface $output): array
     {
-        $this->detectMagento($output, true);
-        if (!$this->initMagento()) {
-            return 0;
+        if (is_array($this->data)) {
+            return $this->data;
         }
 
-        /** @var \Mage_Admin_Model_User $userModel */
         $userModel = $this->getUserModel();
         $userList = $userModel->getCollection();
-        $table = [];
+        $this->data = [];
+        /** @var Mage_Admin_Model_User $user */
         foreach ($userList as $user) {
-            $table[] = [$user->getId(), $user->getUsername(), $user->getEmail(), $user->getIsActive() ? 'active' : 'inactive'];
+            $this->data[] = [
+                $user->getId(),
+                $user->getUsername(),
+                $user->getEmail(),
+                $user->getIsActive() ? 'active' : 'inactive'
+            ];
         }
 
-        $tableHelper = $this->getTableHelper();
-        $tableHelper
-            ->setHeaders(['id', 'username', 'email', 'status'])
-            ->renderByFormat($output, $table, $input->getOption('format'));
-        return 0;
+        return $this->data;
     }
 }

src/N98/Magento/Command/Cache/ListCommand.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 namespace N98\Magento\Command\Cache;
 
+use N98\Magento\Command\CommandFormatable;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
@@ -10,39 +13,48 @@
  *
  * @package N98\Magento\Command\Cache
  */
-class ListCommand extends AbstractCacheCommand
+class ListCommand extends AbstractCacheCommand implements CommandFormatable
 {
-    protected function configure()
+    /**
+     * @var string
+     */
+    public static $defaultName = 'cache:list';
+
+    /**
+     * @var string
+     */
+    public static $defaultDescription = 'Lists all magento caches.';
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getSectionTitle(InputInterface $input, OutputInterface $output): string
     {
-        $this
-            ->setName('cache:list')
-            ->setDescription('Lists all magento caches')
-            ->addFormatOption()
-        ;
+        return 'Caches';
     }
 
     /**
-     * @param InputInterface $input
-     * @param OutputInterface $output
-     * @return int
+     * {@inheritDoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output): int
+    public function getListHeader(InputInterface $input, OutputInterface $output): array
     {
-        $this->detectMagento($output, true);
-        if (!$this->initMagento()) {
-            return 0;
-        }
+        return ['code', 'status'];
+    }
 
-        $cacheTypes = $this->_getCacheModel()->getTypes();
+    /**
+     * {@inheritDoc}
+     */
+    public function getListData(InputInterface $input, OutputInterface $output): array
+    {
         $table = [];
+        $cacheTypes = $this->_getCacheModel()->getTypes();
         foreach ($cacheTypes as $cacheCode => $cacheInfo) {
-            $table[] = [$cacheCode, $cacheInfo['status'] ? 'enabled' : 'disabled'];
+            $table[] = [
+                $cacheCode,
+                $cacheInfo['status'] ? 'enabled' : 'disabled'
+            ];
         }
 
-        $tableHelper = $this->getTableHelper();
-        $tableHelper
-            ->setHeaders(['code', 'status'])
-            ->renderByFormat($output, $table, $input->getOption('format'));
-        return 0;
+        return $table;
     }
 }