[Console] fix phpdoc of Output classes (esp. regarding the new verbosities)
also add missing information
This commit is contained in:
parent
9dcc9facf0
commit
bd61b925a1
@ -36,10 +36,9 @@ class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
|
|||||||
/**
|
/**
|
||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
* @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
|
||||||
* self::VERBOSITY_VERBOSE)
|
* @param Boolean|null $decorated Whether to decorate messages (null for auto-guessing)
|
||||||
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
|
* @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
|
||||||
* @param OutputFormatterInterface $formatter Output formatter instance
|
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -22,9 +22,16 @@ use Symfony\Component\Console\Output\OutputInterface;
|
|||||||
interface ConsoleOutputInterface extends OutputInterface
|
interface ConsoleOutputInterface extends OutputInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
|
* Gets the OutputInterface for errors.
|
||||||
|
*
|
||||||
* @return OutputInterface
|
* @return OutputInterface
|
||||||
*/
|
*/
|
||||||
public function getErrorOutput();
|
public function getErrorOutput();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets the OutputInterface used for errors.
|
||||||
|
*
|
||||||
|
* @param OutputInterface $error
|
||||||
|
*/
|
||||||
public function setErrorOutput(OutputInterface $error);
|
public function setErrorOutput(OutputInterface $error);
|
||||||
}
|
}
|
||||||
|
@ -17,10 +17,12 @@ use Symfony\Component\Console\Formatter\OutputFormatter;
|
|||||||
/**
|
/**
|
||||||
* Base class for output classes.
|
* Base class for output classes.
|
||||||
*
|
*
|
||||||
* There are three levels of verbosity:
|
* There are five levels of verbosity:
|
||||||
*
|
*
|
||||||
* * normal: no option passed (normal output - information)
|
* * normal: no option passed (normal output)
|
||||||
* * verbose: -v (more output - debug)
|
* * verbose: -v (more output)
|
||||||
|
* * very verbose: -vv (highly extended output)
|
||||||
|
* * debug: -vvv (all debug output)
|
||||||
* * quiet: -q (no output)
|
* * quiet: -q (no output)
|
||||||
*
|
*
|
||||||
* @author Fabien Potencier <fabien@symfony.com>
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
@ -35,9 +37,9 @@ abstract class Output implements OutputInterface
|
|||||||
/**
|
/**
|
||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
|
* @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
|
||||||
* @param Boolean $decorated Whether to decorate messages or not
|
* @param Boolean $decorated Whether to decorate messages
|
||||||
* @param OutputFormatterInterface $formatter Output formatter instance
|
* @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@ -137,7 +139,7 @@ abstract class Output implements OutputInterface
|
|||||||
* Writes a message to the output.
|
* Writes a message to the output.
|
||||||
*
|
*
|
||||||
* @param string|array $messages The message as an array of lines or a single string
|
* @param string|array $messages The message as an array of lines or a single string
|
||||||
* @param Boolean $newline Whether to add a newline or not
|
* @param Boolean $newline Whether to add a newline
|
||||||
* @param integer $type The type of output
|
* @param integer $type The type of output
|
||||||
*
|
*
|
||||||
* @throws \InvalidArgumentException When unknown output type is given
|
* @throws \InvalidArgumentException When unknown output type is given
|
||||||
|
@ -36,8 +36,8 @@ interface OutputInterface
|
|||||||
* Writes a message to the output.
|
* Writes a message to the output.
|
||||||
*
|
*
|
||||||
* @param string|array $messages The message as an array of lines or a single string
|
* @param string|array $messages The message as an array of lines or a single string
|
||||||
* @param Boolean $newline Whether to add a newline or not
|
* @param Boolean $newline Whether to add a newline
|
||||||
* @param integer $type The type of output (0: normal, 1: raw, 2: plain)
|
* @param integer $type The type of output (one of the OUTPUT constants)
|
||||||
*
|
*
|
||||||
* @throws \InvalidArgumentException When unknown output type is given
|
* @throws \InvalidArgumentException When unknown output type is given
|
||||||
*
|
*
|
||||||
@ -49,7 +49,9 @@ interface OutputInterface
|
|||||||
* Writes a message to the output and adds a newline at the end.
|
* Writes a message to the output and adds a newline at the end.
|
||||||
*
|
*
|
||||||
* @param string|array $messages The message as an array of lines of a single string
|
* @param string|array $messages The message as an array of lines of a single string
|
||||||
* @param integer $type The type of output (0: normal, 1: raw, 2: plain)
|
* @param integer $type The type of output (one of the OUTPUT constants)
|
||||||
|
*
|
||||||
|
* @throws \InvalidArgumentException When unknown output type is given
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@ -58,7 +60,7 @@ interface OutputInterface
|
|||||||
/**
|
/**
|
||||||
* Sets the verbosity of the output.
|
* Sets the verbosity of the output.
|
||||||
*
|
*
|
||||||
* @param integer $level The level of verbosity
|
* @param integer $level The level of verbosity (one of the VERBOSITY constants)
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@ -67,7 +69,7 @@ interface OutputInterface
|
|||||||
/**
|
/**
|
||||||
* Gets the current verbosity of the output.
|
* Gets the current verbosity of the output.
|
||||||
*
|
*
|
||||||
* @return integer The current level of verbosity
|
* @return integer The current level of verbosity (one of the VERBOSITY constants)
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
@ -76,7 +78,7 @@ interface OutputInterface
|
|||||||
/**
|
/**
|
||||||
* Sets the decorated flag.
|
* Sets the decorated flag.
|
||||||
*
|
*
|
||||||
* @param Boolean $decorated Whether to decorate the messages or not
|
* @param Boolean $decorated Whether to decorate the messages
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -36,10 +36,9 @@ class StreamOutput extends Output
|
|||||||
* Constructor.
|
* Constructor.
|
||||||
*
|
*
|
||||||
* @param mixed $stream A stream resource
|
* @param mixed $stream A stream resource
|
||||||
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
|
* @param integer $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
|
||||||
* self::VERBOSITY_VERBOSE)
|
* @param Boolean|null $decorated Whether to decorate messages (null for auto-guessing)
|
||||||
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
|
* @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
|
||||||
* @param OutputFormatterInterface $formatter Output formatter instance
|
|
||||||
*
|
*
|
||||||
* @throws \InvalidArgumentException When first argument is not a real stream
|
* @throws \InvalidArgumentException When first argument is not a real stream
|
||||||
*
|
*
|
||||||
|
Reference in New Issue
Block a user