Merge pull request #35 from igorsantos07/master

Adding a hiding option to \cli\prompt

Author: danielbachhuber

lib/cli/Shell.php

@@ -13,10 +13,11 @@
 namespace cli;
 
 /**
- * The `Shell` class is a utility class for shell related information such as
- * width.
+ * The `Shell` class is a utility class for shell related tasks such as
+ * information on width.
  */
 class Shell {
+
 	/**
 	 * Returns the number of columns the current shell has for display.
 	 *
@@ -62,6 +63,14 @@ static public function isPiped() {
 			return (function_exists('posix_isatty') && !posix_isatty(STDOUT));
 		}
 	}
+
+	/**
+	 * Uses `stty` to hide input/output completely.
+	 * @param boolean $hidden Will hide/show the next data. Defaults to true.
+	 */
+	static public function hide($hidden = true) {
+		system( 'stty ' . ( $hidden? '-echo' : 'echo' ) );
+	}
 }
 
 ?>

lib/cli/Streams.php

@@ -116,16 +116,25 @@ public static function err( $msg = '' ) {
 	 * @param string  $format  A valid input format. See `fscanf` for documentation.
 	 *                         If none is given, all input up to the first newline
 	 *                         is accepted.
+	 * @param boolean $hide    If true will hide what the user types in.
 	 * @return string  The input with whitespace trimmed.
 	 * @throws \Exception  Thrown if ctrl-D (EOT) is sent as input.
 	 */
-	public static function input( $format = null ) {
+	public static function input( $format = null, $hide = false ) {
+		if ( $hide )
+			Shell::hide();
+
 		if( $format ) {
 			fscanf( static::$in, $format . "\n", $line );
 		} else {
 			$line = fgets( static::$in );
 		}
 
+		if ( $hide ) {
+			Shell::hide( false );
+			echo "\n";
+		}
+
 		if( $line === false ) {
 			throw new \Exception( 'Caught ^D during input' );
 		}
@@ -137,21 +146,22 @@ public static function input( $format = null ) {
 	 * Displays an input prompt. If no default value is provided the prompt will
 	 * continue displaying until input is received.
 	 *
-	 * @param string  $question  The question to ask the user.
-	 * @param string  $default   A default value if the user provides no input.
-	 * @param string  $marker    A string to append to the question and default value
-	 *                           on display.
+	 * @param string      $question The question to ask the user.
+	 * @param bool|string $default  A default value if the user provides no input.
+	 * @param string      $marker   A string to append to the question and default value
+	 *                              on display.
+	 * @param boolean     $hide     Optionally hides what the user types in.
 	 * @return string  The users input.
 	 * @see cli\input()
 	 */
-	public static function prompt( $question, $default = null, $marker = ': ' ) {
+	public static function prompt( $question, $default = null, $marker = ': ', $hide = false ) {
 		if( $default && strpos( $question, '[' ) === false ) {
 			$question .= ' [' . $default . ']';
 		}
 
 		while( true ) {
 			self::out( $question . $marker );
-			$line = self::input();
+			$line = self::input( null, $hide );
 
 			if( !empty( $line ) )
 				return $line;

lib/cli/cli.php

@@ -93,14 +93,15 @@ function input( $format = null ) {
  * Displays an input prompt. If no default value is provided the prompt will
  * continue displaying until input is received.
  *
- * @param string $question The question to ask the user.
- * @param string $default  A default value if the user provides no input.
- * @param string $marker   A string to append to the question and default value on display.
+ * @param string  $question The question to ask the user.
+ * @param string  $default  A default value if the user provides no input.
+ * @param string  $marker   A string to append to the question and default value on display.
+ * @param boolean $hide     If the user input should be hidden
  * @return string  The users input.
  * @see cli\input()
  */
-function prompt( $question, $default = null, $marker = ': ' ) {
-	return Streams::prompt( $question, $default, $marker );
+function prompt( $question, $default = false, $marker = ': ', $hide = false ) {
+	return Streams::prompt( $question, $default, $marker, $hide );
 }
 
 /**