update readme, add new method: askHiddenInput() for read password

Author: inhere

README.md

@@ -80,7 +80,7 @@ $app->run();
 
 然后在命令行里执行 `php examples/app`, 立即就可以看到如下输出了:
 
-!['output-commands-info'](images/output-commands-info.jpg)
+!['output-commands-info'](images/example-app.png)
 
 > `Independent Commands` 中的 demo 就是我们上面添加的命令
 
@@ -194,7 +194,7 @@ class HomeController extends Controller
 
 - 运行效果(by `php examples/app home`):
 
-![command-group-example](./images/command-group-example.jpg)
+![command-group-example](./images/example-for-group.png)
 
 更多请查看 [examples](./examples) 中的示例代码和在目录下运行示例 `php examples/app` 来查看效果
 
@@ -527,6 +527,8 @@ Show::table($data, 'a table', $opts);
 
 > 渲染效果请看下面的预览
 
+![table-show](images/table-show.png)
+
 ### 快速的渲染一个帮助信息面板 
 
 ```php
@@ -558,7 +560,41 @@ Show::helpPanel([
 
 ## 用户交互方法
 
-需引入类 `Inhere\Console\Utils\Interact`
+> 要独立使用的话需引入类 `Inhere\Console\Utils\Interact`， `Controller` 和 `Command` 里可以直接调用相关方法
+
+### 读取用户输入
+
+```php
+public static function read($message = null, $nl = false, array $opts = []): string
+```
+
+- 使用
+
+```php
+$userInput = Interact::read();
+
+// 先输出消息，再读取
+$userInput = Interact::read('Your name:');
+
+// 在 Controller/Command 中
+$userInput = $this->read('Your name:');
+```
+
+### 读取密码输入(隐藏输入文字)
+
+```php
+public static function askHiddenInput(string $prompt = 'Enter Password:'): string
+public static function askPassword(string $prompt = 'Enter Password:'): string
+```
+
+- 使用
+
+```php
+$pwd = Interact::askPassword();
+
+// 在 Controller/Command 中
+$pwd = $this->askPassword();
+```
 
 ### 从给出的列表中选择一项
 

README_en.md

@@ -68,7 +68,7 @@ $app->run();
 
 now, you can see:
 
-!['output-commands-info'](images/output-commands-info.jpg)
+!['output-commands-info'](images/example-app.png)
 
 ## input
 

examples/HomeController.php

@@ -37,9 +37,20 @@ public function indexCommand()
         $this->write('hello, welcome!! this is ' . __METHOD__);
     }
 
+    /**
+     * a example for input password on command line
+     * @usage {fullCommand}
+     */
+    public function passwdCommand()
+    {
+        $pwd = $this->askPassword();
+
+        $this->write('Your input is:' . $pwd);
+    }
+
     /**
      * a example for use color text output on command
-     * @usage ./bin/app home/color
+     * @usage {fullCommand}
      */
     public function colorCommand()
     {
@@ -67,7 +78,7 @@ public function blockMsgCommand()
     {
         $this->write('block message:');
 
-        foreach (Interact::getBlockMethods() as $type) {
+        foreach (Show::getBlockMethods() as $type) {
             $this->output->$type("$type style message text");
         }
 

images/command-group-example.jpg

@@ -105,6 +105,21 @@ protected function createDefinition()
         return $this->definition;
     }
 
+    /**
+     * 为命令注解提供可解析解析变量. 可以在命令的注释中使用
+     * @return array
+     */
+    public function annotationVars()
+    {
+        // e.g: `more info see {name}/index`
+        return [
+            'script' => $this->input->getScript(),
+            'command' => $this->input->getCommand(),
+            'fullCommand' => $this->input->getScript() . ' ' . $this->input->getCommand(),
+            'name' => self::getName(),
+        ];
+    }
+
     /**************************************************************************
      * running a command
      **************************************************************************/
@@ -283,20 +298,6 @@ public function validateInput()
      * helper methods
      **************************************************************************/
 
-    /**
-     * 为命令注解提供可解析解析变量. 可以在命令的注释中使用
-     * @return array
-     */
-    protected function annotationVars()
-    {
-        // e.g: `more info see {name}/index`
-        return [
-            'script' => $this->input->getScript(),
-            'command' => $this->input->getCommand(),
-            'name' => self::getName(),
-        ];
-    }
-
     /**
      * 为命令注解提供可解析解析变量. 可以在命令的注释中使用
      * @param string $str

images/example-app.png

@@ -0,0 +1,5 @@
+# exe file
+
+## Hidden Input
+
+From https://github.com/Seldaek/hidden-input

images/example-for-group.png

@@ -13,6 +13,14 @@
 /**
  * Class UserInteractTrait
  * @package Inhere\Console\Traits
+ * @see Interact
+ *
+ * @method string readRow($message = null, $nl = false)
+ * @method string read($message = null, $nl = false, array $opts = [])
+ *
+ * @method string askHiddenInput(string $prompt = 'Enter Password:')
+ * @method string promptSilent(string $prompt = 'Enter Password:')
+ * @method string askPassword(string $prompt = 'Enter Password:')
  */
 trait UserInteractTrait
 {
@@ -61,18 +69,23 @@ public function question($question, $default = null, \Closure $validator = null)
      * @inheritdoc
      * @see Interact::limitedAsk()
      */
-    public function loopAsk($question, $default = null, \Closure $validator = null, $times = 3)
+    public function limitedAsk($question, $default = null, \Closure $validator = null, $times = 3)
     {
         return Interact::limitedAsk($question, $default, $validator, $times);
     }
 
     /**
-     * @inheritdoc
-     * @see Interact::limitedAsk()
+     * @param string $method
+     * @param array $args
+     * @return int
+     * @throws \LogicException
      */
-    public function limitedAsk($question, $default = null, \Closure $validator = null, $times = 3)
+    public function __call($method, array $args = [])
     {
-        return Interact::limitedAsk($question, $default, $validator, $times);
-    }
+        if (method_exists(Interact::class, $method)) {
+            return Interact::$method(...$args);
+        }
 
+        throw new \LogicException("Call a not exists method: $method of the " . static::class);
+    }
 }