ConsoleOptionParser addSubcommand Sorting - #11838

Implemented an optional sort parameter to \Cake\Console\ConsoleOptionParser::addSubcommand Added unit test for the new parameter.
cakephp · Mar 18, 2018 · 9922197 · 9922197
1 parent 235c724
commit 9922197
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/src/Console/ConsoleOptionParser.php b/src/Console/ConsoleOptionParser.php
@@ -576,9 +576,10 @@ public function addOptions(array $options)
      *
      * @param \Cake\Console\ConsoleInputSubcommand|string $name Name of the subcommand. Will also accept an instance of ConsoleInputSubcommand
      * @param array $options Array of params, see above.
+     * @param boolean $sort
      * @return $this
      */
-    public function addSubcommand($name, array $options = [])
+    public function addSubcommand($name, array $options = [], $sort = true)
     {
         if ($name instanceof ConsoleInputSubcommand) {
             $command = $name;
@@ -595,7 +596,9 @@ public function addSubcommand($name, array $options = [])
             $command = new ConsoleInputSubcommand($options);
         }
         $this->_subcommands[$name] = $command;
-        asort($this->_subcommands);
+        if ($sort) {
+            asort($this->_subcommands);
+        }
 
         return $this;
     }

diff --git a/tests/TestCase/Console/ConsoleOptionParserTest.php b/tests/TestCase/Console/ConsoleOptionParserTest.php
@@ -651,6 +651,20 @@ public function testAddSubcommandObject()
         $this->assertEquals('test', $result['test']->name());
     }
 
+    /**
+     * test addSubcommand without sorting applied.
+     */
+    public function testAddSubcommandSort()
+    {
+        $parser = new ConsoleOptionParser('test', false);
+        $parser->addSubcommand(new ConsoleInputSubcommand('betaTest'), [], false);
+        $parser->addSubcommand(new ConsoleInputSubcommand('alphaTest'), [], false);
+        $result = $parser->subcommands();
+        $this->assertCount(2, $result);
+        $firstResult = key($result);
+        $this->assertEquals('betaTest', $firstResult);
+    }
+
     /**
      * test removeSubcommand with an object.
      *