some update: add command aliases support.

Author: inhere

Something.md

@@ -0,0 +1,41 @@
+# some idea
+
+## controller
+
+```php
+    protected function commandConfigure($definition)
+    {
+        // old: own create.
+        $this->createDefinition()->addArgument();
+        
+        // maybe: get by argument.
+        $definition->addArgument();
+        
+        // ....
+    }
+```
+
+```php
+    /**
+     * the group controller metadata. to define name, description
+     * @return array
+     */
+    public static function metadata()
+    {
+        return [
+            'name' => 'model',
+            'description' => 'some console command handle for model user data.',
+
+            // for command
+            'aliases' => [
+                'i', 'in',
+            ],
+            
+            // for controller
+            'aliases' => [
+                'i' => 'install',
+                'up' => 'update',
+            ]
+        ];
+    }
+```

examples/DemoCommand.php

@@ -23,6 +23,7 @@ class DemoCommand extends Command
 
     /**
      * {@inheritDoc}
+     * @throws \LogicException
      */
     protected function configure()
     {

examples/routes.php

@@ -22,7 +22,10 @@
     $out->info('hello, this is a test command: ' . $cmd);
 });
 
-$app->command('test', TestCommand::class);
+$app->command('test', TestCommand::class, [
+    'aliases' => ['t']
+]);
+
 $app->command('prg', function () {
     $i = 0;
     $total = 120;
@@ -39,5 +42,8 @@
 
 }, 'a description message');
 
-$app->controller('home', HomeController::class);
+$app->controller('home', HomeController::class, [
+    'aliases' => ['h']
+]);
+
 $app->controller(PharController::class);

src/Application.php

@@ -25,10 +25,11 @@ class Application extends AbstractApplication
      * Register a app group command(by controller)
      * @param string $name The controller name
      * @param string $class The controller class
+     * @param null|array|string $option
      * @return static
      * @throws \InvalidArgumentException
      */
-    public function controller(string $name, string $class = null)
+    public function controller(string $name, string $class = null, $option = null)
     {
         if (!$class && class_exists($name)) {
             /** @var Controller $class */
@@ -54,6 +55,18 @@ public function controller(string $name, string $class = null)
 
         $this->controllers[$name] = $class;
 
+        if (!$option) {
+            return $this;
+        }
+
+        // have option information
+        if (\is_string($option)) {
+            $this->addCommandMessage($name, $option);
+        } elseif (\is_array($option)) {
+            $this->addCommandAliases($name, $option['aliases'] ?? null);
+            $this->addCommandMessage($name, $option['description'] ?? null);
+        }
+
         return $this;
     }
 
@@ -79,11 +92,11 @@ public function controllers(array $controllers)
      * Register a app independent console command
      * @param string|Command $name
      * @param string|\Closure|Command $handler
-     * @param null|string $description
+     * @param null|array|string $option
      * @return $this
      * @throws \InvalidArgumentException
      */
-    public function command(string $name, $handler = null, $description = null)
+    public function command(string $name, $handler = null, $option = null)
     {
         if (!$handler && class_exists($name)) {
             /** @var Command $name */
@@ -119,8 +132,16 @@ public function command(string $name, $handler = null, $description = null)
         // is an class name string
         $this->commands[$name] = $handler;
 
-        if ($description) {
-            $this->addCommandMessage($name, $description);
+        if (!$option) {
+            return $this;
+        }
+
+        // have option information
+        if (\is_string($option)) {
+            $this->addCommandMessage($name, $option);
+        } elseif (\is_array($option)) {
+            $this->addCommandAliases($name, $option['aliases'] ?? null);
+            $this->addCommandMessage($name, $option['description'] ?? null);
         }
 
         return $this;
@@ -231,26 +252,30 @@ protected function getFileFilter()
      */
     protected function dispatch($name)
     {
-        $sep = $this->delimiter ?: '/';
+        $sep = $this->delimiter ?: ':';
 
         //// is a command name
 
-        if ($this->isCommand($name)) {
-            return $this->runCommand($name, true);
+        $realName = $this->getRealCommandName($name);
+
+        if ($this->isCommand($realName)) {
+            return $this->runCommand($realName, true);
         }
 
         //// is a controller name
 
         $action = '';
 
-        // like 'home/index'
+        // like 'home:index'
         if (strpos($name, $sep) > 0) {
             $input = array_filter(explode($sep, $name));
             list($name, $action) = \count($input) > 2 ? array_splice($input, 2) : $input;
         }
 
-        if ($this->isController($name)) {
-            return $this->runAction($name, $action, true);
+        $realName = $this->getRealCommandName($name);
+
+        if ($this->isController($realName)) {
+            return $this->runAction($realName, $action, true);
         }
 
         // command not found

src/Base/AbstractApplication.php

@@ -67,17 +67,20 @@ abstract class AbstractApplication implements ApplicationInterface
     /** @var string Command delimiter. e.g dev:serve */
     public $delimiter = ':'; // '/' ':'
 
-    /** @var array The group commands */
-    protected $controllers = [];
+    /** @var string Current command name */
+    private $commandName;
+
+    /** @var array Some message for command */
+    private $commandMessages = [];
+
+    /** @var array Save command aliases */
+    private $commandAliases = [];
 
     /** @var array The independent commands */
     protected $commands = [];
 
-    /** @var array  */
-    private $commandMessages = [];
-
-    /** @var string */
-    private $commandName;
+    /** @var array The group commands */
+    protected $controllers = [];
 
     /**
      * App constructor.
@@ -470,11 +473,44 @@ public function getCommandMessage($name, $default = null)
     /**
      * @param string $name The command name
      * @param string $message
-     * @return string
+     * @return $this
      */
     public function addCommandMessage($name, $message)
     {
-        return $this->commandMessages[$name] = $message;
+        if (!$name || !$message) {
+            $this->commandMessages[$name] = $message;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param string $name
+     * @param string|array $aliases
+     * @return $this
+     */
+    public function addCommandAliases(string $name, $aliases)
+    {
+        if (!$name || !$aliases) {
+            return $this;
+        }
+
+        foreach ((array)$aliases as $alias) {
+            if ($alias = trim($alias)) {
+                $this->commandAliases[$alias] = $name;
+            }
+        }
+
+        return $this;
+    }
+
+    /**
+     * @param string $name
+     * @return string
+     */
+    protected function getRealCommandName(string $name)
+    {
+        return $this->commandAliases[$name] ?? $name;
     }
 
     /**********************************************************
@@ -643,4 +679,20 @@ public function setCommandMessages(array $commandMessages)
     {
         $this->commandMessages = $commandMessages;
     }
+
+    /**
+     * @return array
+     */
+    public function getCommandAliases(): array
+    {
+        return $this->commandAliases;
+    }
+
+    /**
+     * @param array $commandAliases
+     */
+    public function setCommandAliases(array $commandAliases)
+    {
+        $this->commandAliases = $commandAliases;
+    }
 }

src/Base/AbstractCommand.php

@@ -320,7 +320,6 @@ protected function handleAnnotationVars($str)
      * @param string $method
      * @param null|string $action
      * @return int
-     * @throws \ReflectionException
      */
     protected function showHelpByMethodAnnotation($method, $action = null)
     {
@@ -391,7 +390,7 @@ final public static function getName(): string
     /**
      * @return string
      */
-    final public static function getDescription(): ?string
+    final public static function getDescription()
     {
         return static::$description;
     }

src/Base/ApplicationInterface.php

@@ -46,9 +46,33 @@ public function runCommand($name, $believable = false);
      */
     public function runAction($name, $action, $believable = false, $standAlone = false);
 
-    public function controller(string $name, string $controller = null);
+    /**
+     * Register a app group command(by controller)
+     * @param string $name The controller name
+     * @param string $class The controller class
+     * @param null|array|string $option
+     * string: define the description message.
+     * array:
+     *  - aliases     The command aliases
+     *  - description The description message
+     * @return static
+     * @throws \InvalidArgumentException
+     */
+    public function controller(string $name, string $class = null, $option = null);
 
-    public function command(string $name, $handler = null, $description = null);
+    /**
+     * Register a app independent console command
+     * @param string|CommandInterface $name
+     * @param string|\Closure|CommandInterface $handler
+     * @param null|array|string $option
+     * string: define the description message.
+     * array:
+     *  - aliases     The command aliases
+     *  - description The description message
+     * @return $this
+     * @throws \InvalidArgumentException
+     */
+    public function command(string $name, $handler = null, $option = null);
 
     public function showCommandList($quit = true);
 }

src/Base/CommandInterface.php

@@ -41,5 +41,5 @@ public static function getName(): string;
     /**
      * @return string
      */
-    public static function getDescription(): ?string;
+    public static function getDescription();
 }

src/Controller.php

@@ -71,7 +71,6 @@ protected function configure()
      * @param  Input $input
      * @param  Output $output
      * @return mixed
-     * @throws \ReflectionException
      */
     protected function execute($input, $output)
     {
@@ -114,7 +113,6 @@ protected function execute($input, $output)
 
     /**
      * @return int
-     * @throws \ReflectionException
      */
     protected function showHelp()
     {
@@ -136,7 +134,6 @@ protected function showHelp()
      *  {script} {name} index
      *
      * @return int
-     * @throws \ReflectionException
      */
     final public function helpCommand()
     {
@@ -157,7 +154,6 @@ final public function helpCommand()
 
     /**
      * show command list of the controller class
-     * @throws \ReflectionException
      */
     final public function showCommandList()
     {