Skip to content

Commit

Permalink
Adding documentation for output levels.
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed Oct 14, 2010
1 parent 4be57a2 commit 124a910
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions cake/console/libs/shell.php
Expand Up @@ -451,8 +451,16 @@ protected function _getInput($prompt, $options, $default) {
* Outputs a single or multiple messages to stdout. If no parameters
* are passed outputs just a newline.
*
* ### Output levels
*
* There are 3 built-in output level. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE.
* The verbose and quiet output levels, map to the `verbose` and `quiet` output switches
* present in most shells. Using Shell::QUIET for a message means it will always display.
* While using Shell::VERBOSE means it will only display when verbose output is toggled.
*
* @param mixed $message A string or a an array of strings to output
* @param integer $newlines Number of newlines to append
* @param integer $level The message's output level, see above.
* @return integer Returns the number of bytes returned from writing to stdout.
*/
public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {
Expand Down

0 comments on commit 124a910

Please sign in to comment.