Merge pull request #11 from OXIDprojects/service.yaml-support

added support for adding commands from services.yaml

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog for OXID Console
 
+## [v5.2.0]
+### Added
+- Support for commands registered via services.yaml of other composer packages  
+
 ## [v5.1.0]
 ### Added
 - Support for commands registered via composer.json of other composer packages  

README.md

@@ -45,13 +45,13 @@ vendor/bin/oxid list
 
 ## Defining your own command
 * Class must extend `Symfony\Component\Console\Command\Command` class
-* in the composer json of your module 
-```json 
-  "extra": {
-    "oxideshop": {
-      "console-commands" : ["OxidCommunity\\ModuleInternals\\Command\\ModuleFixCommand"]
-    }
-  },
+* in the service.yaml json of your module (composer package) 
+```yaml 
+  services:
+    oxid_community.moduleinternals.module.fix.command:
+      class: OxidCommunity\ModuleInternals\Command\ModuleFixCommand
+      tags:
+      - { name: 'console.command' }
 ```
 
 ### Template for your command:

bin/oxid

@@ -51,22 +51,19 @@ try {
 
     $commandCollector = new CommandCollector();
     $application = new Application('OXID Console', $version);
-    $application->addCommands($commandCollector->getAllCommands());
+    $commands = $commandCollector->getAllCommands();
+    foreach ($commands as $command) {
+        try {
+            $application->add($command);
+        } catch (Throwable $e) {
+            print get_class($command) . " not loadad " . $e->getMessage() . "\n" . $e->getTraceAsString();
+        }
+    }
     $application->run();
 } catch (Throwable $ex) {
     //console should print errors always
     print $ex->getMessage();
     print $ex->getTraceAsString();
-    /*
-    $i = 0;
-    foreach ($ex->getTrace() as $frame) {
-        echo sprintf("#%d %s(%d): %s(%s)\n",
-            $i++, $frame["file"], $frame["line"],
-            $frame["function"],
-            implode(", ", array_map(
-                function ($e) { return var_export($e, true); }, $frame["args"])));
-    }
-    */
-    //shop exception hanlder may tke care about error code and logging
+    //shop exception handler may take care about error code and logging
     throw $ex;
 }

src/Core/CommandCollector.php

@@ -16,6 +16,9 @@
 use OxidEsales\Eshop\Core\Registry;
 use OxidEsales\Eshop\Core\Module\ModuleList;
 use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Config\FileLocator;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
 use OxidProfessionalServices\OxidConsole\Command\CacheClearCommand;
 use OxidProfessionalServices\OxidConsole\Command\DatabaseUpdateCommand;
@@ -82,23 +85,38 @@ private function getCommandsFromCore()
 
     private function getCommandsFromComposer(){
 
-        $nio = new \Composer\IO\NullIO();
-        $factory = new \Composer\Factory();
-        $oConfig = Registry::getConfig();
+
         $localRepository = new InstalledFilesystemRepository(new JsonFile(VENDOR_PATH.'/composer/installed.json'));
 
         $commandsClasses = [];
 
         $packages = $localRepository->getPackages();
+
+        $symfonyContainer = new ContainerBuilder();
+        $loader = new YamlFileLoader($symfonyContainer, new FileLocator());
+
         foreach ($packages as $package) {
+            //deprecated syntax to be removed
             $extra = $package->getExtra();
             $oxideshop = isset($extra['oxideshop']) ? $extra['oxideshop'] : [];
             $consoleCommands = isset($oxideshop['console-commands']) && is_array($oxideshop['console-commands']) ?
                 $oxideshop['console-commands'] : [];
             foreach ($consoleCommands as $commandClass) {
                 $commandsClasses[] = new $commandClass;
             }
+            //end of deprecated code
+
+            $serviceFile =  VENDOR_PATH  . $package->getName() . '/services.yaml';
+            if (file_exists($serviceFile)) {
+                $loader->load($serviceFile);
+            }
         }
+        foreach ($symfonyContainer->findTaggedServiceIds('console.command') as $id => $tags) {
+            $definition = $symfonyContainer->getDefinition($id);
+            $class = $definition->getClass();
+            $commandsClasses[] = new $class;
+        }
+
         return $commandsClasses;
     }