Update BaseConsole.php

yiisoft · Jan 7, 2017 · 3050ded · 3050ded
1 parent 92270bc
commit 3050ded
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/framework/helpers/BaseConsole.php b/framework/helpers/BaseConsole.php
@@ -805,6 +805,16 @@ public static function prompt($text, $options = [])
     /**
      * Asks user to confirm by typing y or n.
      *
+     * A typical usage looks like the following:
+     *
+     * ```php
+     * if (Console::confirm("Are you sure?")) {
+     *     echo "user typed yes\n";
+     * } else {
+     *     echo "user typed no\n";
+     * }
+     * ```
+     *
      * @param string $message to print out before waiting for user input
      * @param bool $default this value is returned if no selection is made.
      * @return bool whether user confirmed