rename some class, update some ...

Author: inhere

src/AbstractCommand.php renamed to src/AbstractHandler.php

@@ -8,7 +8,7 @@
 
 namespace Inhere\Console;
 
-use Inhere\Console\Contract\BaseCommandInterface;
+use Inhere\Console\Contract\CommandHandlerInterface;
 use Inhere\Console\Contract\CommandInterface;
 use Inhere\Console\IO\Input;
 use Inhere\Console\IO\InputDefinition;
@@ -22,10 +22,10 @@
 use Toolkit\PhpUtil\PhpDoc;
 
 /**
- * Class AbstractCommand
+ * Class AbstractHandler
  * @package Inhere\Console
  */
-abstract class AbstractCommand implements BaseCommandInterface
+abstract class AbstractHandler implements CommandHandlerInterface
 {
     use InputOutputAwareTrait, UserInteractAwareTrait;
 
@@ -257,7 +257,7 @@ public function coroutineRun(): bool
     }
 
     /**
-     * before command execute
+     * Before command execute
      * @return boolean It MUST return TRUE to continue execute.
      */
     protected function beforeExecute(): bool
@@ -266,15 +266,15 @@ protected function beforeExecute(): bool
     }
 
     /**
-     * do execute command
+     * Do execute command
      * @param  Input  $input
      * @param  Output $output
      * @return int|mixed
      */
     abstract protected function execute($input, $output);
 
     /**
-     * after command execute
+     * After command execute
      */
     protected function afterExecute(): void
     {
@@ -575,8 +575,7 @@ protected function showHelpByMethodAnnotations(string $method, string $action =
         }
 
         $help['Global Options:'] = FormatUtil::alignOptions(
-            \array_merge(Application::getGlobalOptions(),
-                $this->commonOptions)
+            \array_merge(Application::getGlobalOptions(), $this->commonOptions)
         );
         $this->output->mList($help, [
             'sepChar'     => '  ',

src/Command.php

@@ -24,21 +24,18 @@
  *  }
  * ```
  */
-abstract class Command extends AbstractCommand implements CommandInterface
+abstract class Command extends AbstractHandler implements CommandInterface
 {
     /*
-     * do execute
-     * @param  \Inhere\Console\IO\Input $input
-     * @param  \Inhere\Console\IO\Output $output
-     * @return int
+     * Do execute command
      */
     // protected function execute($input, $output)
     // {
     //      // something logic ...
     // }
 
     /*
-     * configure
+     * Configure command
      */
     // protected function configure()
     // {
@@ -49,6 +46,7 @@ abstract class Command extends AbstractCommand implements CommandInterface
     // }
 
     /**
+     * Show help information
      * @return bool
      * @throws \ReflectionException
      */

src/Contract/BaseCommandInterface.php renamed to src/Contract/CommandHandlerInterface.php

@@ -9,13 +9,15 @@
 namespace Inhere\Console\Contract;
 
 use Inhere\Console\AbstractApplication;
+use Inhere\Console\IO\Input;
 use Inhere\Console\IO\InputDefinition;
+use Inhere\Console\IO\Output;
 
 /**
- * Interface BaseCommandInterface
+ * Interface CommandHandlerInterface
  * @package Inhere\Console\Contract
  */
-interface BaseCommandInterface
+interface CommandHandlerInterface
 {
     public const OK  = 0;
     public const ERR = 2;
@@ -24,7 +26,7 @@ interface BaseCommandInterface
     public const ANNOTATION_VAR = '{%s}'; // '{$%s}';
 
     /**
-     * run command
+     * Run command
      * @param string $command
      * @return int|mixed return int is exit code. other is command exec result.
      */

src/Contract/CommandInterface.php

@@ -12,6 +12,6 @@
  * Interface CommandInterface
  * @package Inhere\Console\Contract
  */
-interface CommandInterface extends BaseCommandInterface
+interface CommandInterface extends CommandHandlerInterface
 {
 }

src/Controller.php

@@ -21,7 +21,7 @@
  * Class Controller
  * @package Inhere\Console
  */
-abstract class Controller extends AbstractCommand implements ControllerInterface
+abstract class Controller extends AbstractHandler implements ControllerInterface
 {
     /** @var array sub-command aliases */
     private static $commandAliases = [];
@@ -108,10 +108,11 @@ public function run(string $command = '')
     }
 
     /**
-     * load command configure
+     * Load command configure
      */
     protected function configure(): void
     {
+        // eg. IndexConfigure() for indexCommand()
         $method = $this->action . 'Configure';
 
         if (\method_exists($this, $method)) {
@@ -120,13 +121,14 @@ protected function configure(): void
     }
 
     /**
-     * 运行控制器的 action
+     * Run command action in the group
+     *
      * @param  Input  $input
      * @param  Output $output
      * @return mixed
      * @throws \ReflectionException
      */
-    protected function execute($input, $output)
+    final public function execute($input, $output)
     {
         $action = $this->action;
         $group  = static::getName();
@@ -240,7 +242,7 @@ final public function showCommandList(): void
         $sName = \lcfirst(self::getName() ?: $ref->getShortName());
 
         if (!($classDes = self::getDescription())) {
-            $classDes = PhpDoc::description($ref->getDocComment()) ?: 'No description for the console controller';
+            $classDes = PhpDoc::description($ref->getDocComment()) ?: 'No description for the command group';
         }
 
         $commands     = [];

src/Router.php

@@ -302,9 +302,13 @@ protected function validateName(string $name): void
         }
     }
 
-    public function each(callable $fn)
+    /**
+     * @param callable $grpFunc
+     * @param callable $cmdFunc
+     */
+    public function sortedEach(callable $grpFunc, callable $cmdFunc): void
     {
-
+        // todo ...
     }
 
     /**********************************************************

src/Traits/ApplicationHelpTrait.php

@@ -138,7 +138,7 @@ public function showCommandList(): void
         foreach ($groups as $name => $info) {
             $options    = $info['options'];
             $controller = $info['handler'];
-            /** @var \Inhere\Console\AbstractCommand $controller */
+            /** @var \Inhere\Console\AbstractHandler $controller */
             $desc    = $controller::getDescription() ?: $placeholder;
             $aliases = $options['aliases'];
             $extra   = $aliases ? ColorTag::wrap(
@@ -159,7 +159,7 @@ public function showCommandList(): void
             $options = $info['options'];
             $command = $info['handler'];
 
-            /** @var \Inhere\Console\AbstractCommand $command */
+            /** @var \Inhere\Console\AbstractHandler $command */
             if (\is_subclass_of($command, CommandInterface::class)) {
                 $desc = $command::getDescription() ?: $placeholder;
             } elseif ($msg = $options['description'] ?? '') {