adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 11:28:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding documentation for output levels.

Browse source
This commit is contained in:
mark_story 2010-10-13 23:44:50 -04:00
parent 4be57a2ea5
commit 124a910830
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
cake/console/libs/shell.php
View file

@ -451,8 +451,16 @@ class Shell extends Object {
* Outputs a single or multiple messages to stdout. If no parameters * Outputs a single or multiple messages to stdout. If no parameters
* are passed outputs just a newline. * 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 mixed $message A string or a an array of strings to output
* @param integer $newlines Number of newlines to append * @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. * @return integer Returns the number of bytes returned from writing to stdout.
*/ */
public function out($message = null, $newlines = 1, $level = Shell::NORMAL) { public function out($message = null, $newlines = 1, $level = Shell::NORMAL) {