| 148 |
lars |
1 |
<?php
|
|
|
2 |
|
|
|
3 |
/*
|
|
|
4 |
* This file is part of the Symfony package.
|
|
|
5 |
*
|
|
|
6 |
* (c) Fabien Potencier <fabien@symfony.com>
|
|
|
7 |
*
|
|
|
8 |
* For the full copyright and license information, please view the LICENSE
|
|
|
9 |
* file that was distributed with this source code.
|
|
|
10 |
*/
|
|
|
11 |
|
|
|
12 |
namespace Symfony\Component\Console\Output;
|
|
|
13 |
|
|
|
14 |
use Symfony\Component\Console\Formatter\OutputFormatterInterface;
|
|
|
15 |
|
|
|
16 |
/**
|
|
|
17 |
* OutputInterface is the interface implemented by all Output classes.
|
|
|
18 |
*
|
|
|
19 |
* @author Fabien Potencier <fabien@symfony.com>
|
|
|
20 |
*/
|
|
|
21 |
interface OutputInterface
|
|
|
22 |
{
|
|
|
23 |
public const VERBOSITY_QUIET = 16;
|
|
|
24 |
public const VERBOSITY_NORMAL = 32;
|
|
|
25 |
public const VERBOSITY_VERBOSE = 64;
|
|
|
26 |
public const VERBOSITY_VERY_VERBOSE = 128;
|
|
|
27 |
public const VERBOSITY_DEBUG = 256;
|
|
|
28 |
|
|
|
29 |
public const OUTPUT_NORMAL = 1;
|
|
|
30 |
public const OUTPUT_RAW = 2;
|
|
|
31 |
public const OUTPUT_PLAIN = 4;
|
|
|
32 |
|
|
|
33 |
/**
|
|
|
34 |
* Writes a message to the output.
|
|
|
35 |
*
|
|
|
36 |
* @param bool $newline Whether to add a newline
|
|
|
37 |
* @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
|
|
|
38 |
* 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
|
|
|
39 |
*/
|
|
|
40 |
public function write(string|iterable $messages, bool $newline = false, int $options = 0);
|
|
|
41 |
|
|
|
42 |
/**
|
|
|
43 |
* Writes a message to the output and adds a newline at the end.
|
|
|
44 |
*
|
|
|
45 |
* @param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants),
|
|
|
46 |
* 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
|
|
|
47 |
*/
|
|
|
48 |
public function writeln(string|iterable $messages, int $options = 0);
|
|
|
49 |
|
|
|
50 |
/**
|
|
|
51 |
* Sets the verbosity of the output.
|
|
|
52 |
*/
|
|
|
53 |
public function setVerbosity(int $level);
|
|
|
54 |
|
|
|
55 |
/**
|
|
|
56 |
* Gets the current verbosity of the output.
|
|
|
57 |
*/
|
|
|
58 |
public function getVerbosity(): int;
|
|
|
59 |
|
|
|
60 |
/**
|
|
|
61 |
* Returns whether verbosity is quiet (-q).
|
|
|
62 |
*/
|
|
|
63 |
public function isQuiet(): bool;
|
|
|
64 |
|
|
|
65 |
/**
|
|
|
66 |
* Returns whether verbosity is verbose (-v).
|
|
|
67 |
*/
|
|
|
68 |
public function isVerbose(): bool;
|
|
|
69 |
|
|
|
70 |
/**
|
|
|
71 |
* Returns whether verbosity is very verbose (-vv).
|
|
|
72 |
*/
|
|
|
73 |
public function isVeryVerbose(): bool;
|
|
|
74 |
|
|
|
75 |
/**
|
|
|
76 |
* Returns whether verbosity is debug (-vvv).
|
|
|
77 |
*/
|
|
|
78 |
public function isDebug(): bool;
|
|
|
79 |
|
|
|
80 |
/**
|
|
|
81 |
* Sets the decorated flag.
|
|
|
82 |
*/
|
|
|
83 |
public function setDecorated(bool $decorated);
|
|
|
84 |
|
|
|
85 |
/**
|
|
|
86 |
* Gets the decorated flag.
|
|
|
87 |
*/
|
|
|
88 |
public function isDecorated(): bool;
|
|
|
89 |
|
|
|
90 |
public function setFormatter(OutputFormatterInterface $formatter);
|
|
|
91 |
|
|
|
92 |
/**
|
|
|
93 |
* Returns current output formatter instance.
|
|
|
94 |
*/
|
|
|
95 |
public function getFormatter(): OutputFormatterInterface;
|
|
|
96 |
}
|