Stubbing out new @Calls annotation.

consolidation · Jan 17, 2017 · 2647005 · 2647005
1 parent f8567e3
commit 2647005
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 0 deletions.
diff --git a/src/AnnotatedCommand.php b/src/AnnotatedCommand.php
@@ -29,6 +29,7 @@
  */
 class AnnotatedCommand extends Command implements HelpDocumentAlter
 {
+    protected $calls = [];
     protected $commandCallback;
     protected $commandProcessor;
     protected $annotationData;
@@ -120,8 +121,20 @@ public function setTopics($topics)
         return $this;
     }
 
+    public function getCalls()
+    {
+        return $this->calls;
+    }
+
+    public function setCalls($calls)
+    {
+        $this->calls = $calls;
+        return $this;
+    }
+
     public function setCommandInfo($commandInfo)
     {
+        $this->setCalls($commandInfo->getCalls());
         $this->setDescription($commandInfo->getDescription());
         $this->setHelp($commandInfo->getHelp());
         $this->setAliases($commandInfo->getAliases());
@@ -376,11 +389,23 @@ protected function initialize(InputInterface $input, OutputInterface $output)
         $this->commandProcessor()->initializeHook($input, $this->getNames(), $this->annotationData);
     }
 
+    protected function executeCallsCommands() {
+        if ($this->getCalls()) {
+            foreach ($this->getCalls as $command_name) {
+                // @todo validate that $command_name exists in this application.
+                // @todo Execute command.
+                // @todo On failure, return exit code of called command.
+            }
+        }
+    }
+
     /**
      * {@inheritdoc}
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
+        // @todo Call $this->executeCallsCommands();
+
         // Validate, run, process, alter, handle results.
         return $this->commandProcessor()->process(
             $output,

diff --git a/src/Parser/CommandInfo.php b/src/Parser/CommandInfo.php
@@ -83,6 +83,11 @@ class CommandInfo
      */
     protected $optionParamName;
 
+    /**
+     * @var array
+     */
+    protected $calls = [];
+
     /**
      * Create a new CommandInfo class for a particular method of a class.
      *
@@ -333,6 +338,25 @@ public function getTopics()
         return explode(',', trim($topics));
     }
 
+    /**
+     * Returns an array of commands that this command calls.
+     *
+     * @return string[]
+     */
+    public function getCalls()
+    {
+        return $this->calls;
+    }
+
+    public function setCalls($calls) {
+        if (is_string($calls)) {
+            $calls = explode(',', static::convertListToCommaSeparated($calls));
+        }
+        $this->calls = array_filter($calls);
+
+        return $this;
+    }
+
     /**
      * Return the list of refleaction parameters.
      *

diff --git a/src/Parser/Internal/AbstractCommandDocBlockParser.php b/src/Parser/Internal/AbstractCommandDocBlockParser.php
@@ -36,6 +36,7 @@ abstract class AbstractCommandDocBlockParser
         'usage' => 'processUsageTag',
         'description' => 'processAlternateDescriptionTag',
         'desc' => 'processAlternateDescriptionTag',
+        'calls' => 'processCalls',
     ];
 
     public function __construct(CommandInfo $commandInfo, \ReflectionMethod $reflection)
@@ -168,6 +169,14 @@ protected function processAliases($tag)
         $this->commandInfo->setAliases((string)$tag->getDescription());
     }
 
+    /**
+     * Process the comma-separated list of commands to call.
+     */
+    protected function processCalls($tag)
+    {
+        $this->commandInfo->setCalls((string)$tag->getDescription());
+    }
+
     /**
      * Store the data from a @param annotation in our argument descriptions.
      */