update: add more param type difine. some update...

Author: inhere

docs/catelog.md docs/catalog.mddocs/catelog.md renamed to docs/catalog.md

@@ -12,7 +12,7 @@ require dirname(__DIR__) . '/test/boot.php';
 
 $in = new \Inhere\Console\IO\Input();
 $ctrl = new HomeController($in, new \Inhere\Console\IO\Output());
-$ctrl->setStandAlone();
+$ctrl->setExecutionAlone();
 
 try {
   exit($ctrl->run($in->getCommand()));

examples/home

@@ -104,7 +104,7 @@ public function controllers(array $controllers)
      * @param string|Command $name
      * @param string|\Closure|Command $handler
      * @param null|array|string $option
-     * @return $this
+     * @return $this|mixed
      * @throws \InvalidArgumentException
      */
     public function command(string $name, $handler = null, $option = null)
@@ -393,7 +393,7 @@ public function runAction($name, $action, $believable = false, $standAlone = fal
         $object::setName($name);
         $object->setApp($this);
         $object->setDelimiter($this->delimiter);
-        $object->setStandAlone($standAlone);
+        $object->setExecutionAlone($standAlone);
 
         return $object->run($action);
     }

src/Application.php

@@ -261,9 +261,10 @@ protected function showHelp(): bool
 
     /**
      * prepare run
+     * @throws \InvalidArgumentException
      * @throws \RuntimeException
      */
-    protected function prepare()
+    protected function prepare(): bool
     {
         if ($this->processTitle) {
             if (\function_exists('cli_set_process_title')) {
@@ -285,6 +286,7 @@ protected function prepare()
     /**
      * validate input arguments and options
      * @return bool
+     * @throws \InvalidArgumentException
      */
     public function validateInput(): bool
     {
@@ -398,11 +400,11 @@ protected function addAnnotationVars(array $map)
 
     /**
      * @param string $name
-     * @param string $value
+     * @param string|array $value
      */
     protected function setAnnotationVar(string $name, $value)
     {
-        $this->annotationVars[$name] = (string)$value;
+        $this->annotationVars[$name] = \is_array($value) ? \implode(',', $value) : (string)$value;
     }
 
     /**

src/Base/AbstractCommand.php

@@ -69,7 +69,7 @@ public function controller(string $name, string $class = null, $option = null);
      * array:
      *  - aliases     The command aliases
      *  - description The description message
-     * @return $this
+     * @return mixed
      * @throws \InvalidArgumentException
      */
     public function command(string $name, $handler = null, $option = null);

src/Base/ApplicationInterface.php

@@ -36,8 +36,8 @@ abstract class Controller extends AbstractCommand implements ControllerInterface
     /** @var string */
     private $delimiter = ':'; // '/' ':'
 
-    /** @var bool */
-    private $standAlone = false;
+    /** @var bool Execution alone */
+    private $executionAlone = false;
 
     /** @var string */
     private $defaultAction = 'help';
@@ -228,7 +228,7 @@ protected function beforeShowCommandList()
     {
         // do something ...
     }
-    
+
     /**
      * show command list of the controller class
      * @throws \ReflectionException
@@ -284,7 +284,7 @@ final public function showCommandList()
 
         $script = $this->getScriptName();
 
-        if ($this->standAlone) {
+        if ($this->executionAlone) {
             $name = $sName . ' ';
             $usage = "$script <info>{command}</info> [arguments ...] [options ...]";
         } else {
@@ -305,7 +305,7 @@ final public function showCommandList()
 
         $this->write(sprintf(
             "More information about a command, please use: <cyan>$script $name{command} -h</cyan>",
-            $this->standAlone ? ' ' . $name : ''
+            $this->executionAlone ? ' ' . $name : ''
         ));
         $this->output->flush();
     }
@@ -403,7 +403,7 @@ public function getAction(): string
      * @param string $action
      * @return $this
      */
-    public function setAction(string $action)
+    public function setAction(string $action): self
     {
         if ($action) {
             $this->action = FormatUtil::camelCase($action);
@@ -463,17 +463,17 @@ public function setNotFoundCallback(string $notFoundCallback)
     /**
      * @return bool
      */
-    public function isStandAlone(): bool
+    public function isExecutionAlone(): bool
     {
-        return $this->standAlone;
+        return $this->executionAlone;
     }
 
     /**
-     * @param bool $standAlone
+     * @param bool $executionAlone
      */
-    public function setStandAlone($standAlone = true)
+    public function setExecutionAlone($executionAlone = true)
     {
-        $this->standAlone = (bool)$standAlone;
+        $this->executionAlone = (bool)$executionAlone;
     }
 
     /**

src/Controller.php

@@ -53,7 +53,7 @@ class LiteApp
     /**
      * @param bool $exit
      */
-    public function run($exit = true)
+    public function run(bool $exit = true)
     {
         $this->parseCliArgv();
 
@@ -68,7 +68,7 @@ public function run($exit = true)
     /**
      * @param bool $exit
      */
-    public function dispatch($exit = true)
+    public function dispatch(bool $exit = true)
     {
         if (!$command = $this->command) {
             $this->showCommands();
@@ -100,12 +100,12 @@ public function stop($code = 0)
     }
 
     /**
-     * @param $command
+     * @param string $command
      * @param $handler
      * @return mixed
      * @throws \InvalidArgumentException
      */
-    public function runHandler($command, $handler)
+    public function runHandler(string $command, $handler)
     {
         if (\is_string($handler)) {
             // function name
@@ -192,7 +192,7 @@ public function parseCliArgv()
      * @param string $description
      * @throws \InvalidArgumentException
      */
-    public function addCommand($command, $handler, $description = '')
+    public function addCommand(string $command, $handler, $description = '')
     {
         if (!$command || !$handler) {
             throw new \InvalidArgumentException('Invalid arguments');

src/LiteApp.php

@@ -24,7 +24,7 @@ final class Annotation
      * @param array $ignored
      * @return array The parsed tags
      */
-    public static function getTags($comment, array $ignored = ['param', 'return']): array
+    public static function getTags(string $comment, array $ignored = ['param', 'return']): array
     {
         $comment = str_replace("\r\n", "\n", trim($comment, "/ \n"));
         $comment = "@description \n" . str_replace("\r", '',
@@ -57,10 +57,10 @@ public static function getTags($comment, array $ignored = ['param', 'return']):
     /**
      * Returns the first line of docBlock.
      *
-     * @param  $comment
+     * @param string $comment
      * @return string
      */
-    public static function firstLine($comment): string
+    public static function firstLine(string $comment): string
     {
         $docLines = preg_split('~\R~u', $comment);
 
@@ -75,10 +75,10 @@ public static function firstLine($comment): string
      * Returns full description from the doc-block.
      * If have multi line text, will return multi line.
      *
-     * @param  $comment
+     * @param string $comment
      * @return string
      */
-    public static function description($comment): string
+    public static function description(string $comment): string
     {
         $comment = str_replace("\r", '', trim(preg_replace('/^\s*\**( |\t)?/m', '', trim($comment, '/'))));