Регистрация команд битриксовых модулей

Author: ProklUng

Services/Console/ConsoleCommandConfigurator.php

@@ -9,6 +9,7 @@
 use Symfony\Component\Console\Exception\CommandNotFoundException;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
+use Bitrix\Main\ModuleManager;
 
 /**
  * Class ConsoleCommandConfigurator
@@ -17,6 +18,7 @@
  * @since 10.12.2020
  * @since 20.12.2020 Рефакторинг. Форк нативного способа подключения команд.
  * @since 26.02.2021 Убрал array_merge в цикле.
+ * @since 12.01.2021 Подхватывание команд установленных битриксовых модулей.
  */
 class ConsoleCommandConfigurator
 {
@@ -126,6 +128,51 @@ public function setAutoExit(bool $autoexit) : void
         $this->application->setAutoExit($autoexit);
     }
 
+    /**
+     * Регистрация команд битриксовых модулей.
+     *
+     * @return void
+     *
+     * @since 12.01.2021
+     *
+     * @internal Формат файла cli.php в папке модуля.
+     * return [
+     *      new SampleCommand(), // Должен наследоваться от \Symfony\Component\Console\Command\Command
+     *      container()->get('sample.command') // Из контейнера
+     * ]
+     */
+    private function registerModuleCommands() : void
+    {
+        // Проверка - в Битриксе мы или нет.
+        if (!class_exists(ModuleManager::class)) {
+            return;
+        }
+
+        $result = [];
+
+        $documentRoot = $this->container->getParameter('kernel.project_dir');
+
+        foreach (glob($documentRoot . '/local/modules/*/cli.php') as $path) {
+            $moduleName = $this->getModuleNameByPath($path);
+            if (ModuleManager::isModuleInstalled($moduleName)) {
+                $result = require_once $path;
+            }
+        }
+
+        foreach (glob($documentRoot . '/bitrix/modules/*/cli.php') as $path) {
+            $moduleName = $this->getModuleNameByPath($path);
+            if (ModuleManager::isModuleInstalled($moduleName)) {
+                $result  = require_once $path;
+            }
+        }
+
+        foreach ((array)$result as $item) {
+            if (is_subclass_of($item, Command::class)) {
+                $this->application->add($item);
+            }
+        }
+    }
+
     /**
      * Регистрация команд.
      *
@@ -160,5 +207,31 @@ private function registerCommands() : void
                 }
             }
         }
+
+        $this->registerModuleCommands();
+    }
+
+    /**
+     * Название битриксового модуля по пути.
+     *
+     * @param string $path
+     *
+     * @return string
+     * @since 12.01.2021
+     */
+    private function getModuleNameByPath(string $path): string
+    {
+        $documentRoot = $this->container->getParameter('kernel.project_dir');
+
+        $path = str_replace(
+            [
+                $documentRoot . '/bitrix/modules/',
+                $documentRoot . '/local/modules/',
+            ],
+            '',
+            $path
+        );
+
+        return current(explode('/', $path));
     }
-}
+}

composer.json

@@ -67,7 +67,14 @@
     "league/html-to-markdown": "^5.0"
   },
   "require-dev": {
-    "proklung/phpunit-testing-tools": "^1.0",
+    "proklung/phpunit-testing-tools": "^1.5",
     "icanhazstring/composer-unused": "^0.7.5"
+  },
+  "config": {
+    "allow-plugins": {
+      "composer/package-versions-deprecated": true,
+      "phpstan/extension-installer": true,
+      "icanhazstring/composer-unused": true
+    }
   }
 }

readme.MD

@@ -134,6 +134,22 @@ framework:
 - `debug:autowiring`
 - `config:dump-reference`
 
+### Автоматическое подхватывание команд установленых битриксовых модулей
+
+Конструкция пробегает по установленным (в папках `local` и `bitrix` модулям), где ищет файл `cli.php`. 
+Он должен возвращать массив с инициализированными командами этого модуля. 
+
+```php
+    return [
+        new ExampleCommand(), // Должен наследоваться от \Symfony\Component\Console\Command\Command
+        container()->get('console.command.about') // Из глобального контейнера
+    ];
+```
+
+Эти команды регистрируются в общем для приложения контейнере команд и доступны через `php bin/console`.
+
+Если пакет запускается не в Битриксе - ничего страшного, функционал игнорируется.
+
 ## Расширения
 
 Любое расширение может быть отключено проставлением `false` параметру `enabled` соответствующего раздела файла