Chris@0
|
1 <?php
|
Chris@0
|
2
|
Chris@0
|
3 /*
|
Chris@0
|
4 * This file is part of the Symfony package.
|
Chris@0
|
5 *
|
Chris@0
|
6 * (c) Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
7 *
|
Chris@0
|
8 * For the full copyright and license information, please view the LICENSE
|
Chris@0
|
9 * file that was distributed with this source code.
|
Chris@0
|
10 */
|
Chris@0
|
11
|
Chris@0
|
12 namespace Symfony\Component\Console\Output;
|
Chris@0
|
13
|
Chris@17
|
14 use Symfony\Component\Console\Formatter\OutputFormatter;
|
Chris@0
|
15 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
|
Chris@0
|
16
|
Chris@0
|
17 /**
|
Chris@0
|
18 * Base class for output classes.
|
Chris@0
|
19 *
|
Chris@0
|
20 * There are five levels of verbosity:
|
Chris@0
|
21 *
|
Chris@0
|
22 * * normal: no option passed (normal output)
|
Chris@0
|
23 * * verbose: -v (more output)
|
Chris@0
|
24 * * very verbose: -vv (highly extended output)
|
Chris@0
|
25 * * debug: -vvv (all debug output)
|
Chris@0
|
26 * * quiet: -q (no output)
|
Chris@0
|
27 *
|
Chris@0
|
28 * @author Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
29 */
|
Chris@0
|
30 abstract class Output implements OutputInterface
|
Chris@0
|
31 {
|
Chris@0
|
32 private $verbosity;
|
Chris@0
|
33 private $formatter;
|
Chris@0
|
34
|
Chris@0
|
35 /**
|
Chris@0
|
36 * @param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
|
Chris@0
|
37 * @param bool $decorated Whether to decorate messages
|
Chris@0
|
38 * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
|
Chris@0
|
39 */
|
Chris@0
|
40 public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = false, OutputFormatterInterface $formatter = null)
|
Chris@0
|
41 {
|
Chris@0
|
42 $this->verbosity = null === $verbosity ? self::VERBOSITY_NORMAL : $verbosity;
|
Chris@0
|
43 $this->formatter = $formatter ?: new OutputFormatter();
|
Chris@0
|
44 $this->formatter->setDecorated($decorated);
|
Chris@0
|
45 }
|
Chris@0
|
46
|
Chris@0
|
47 /**
|
Chris@0
|
48 * {@inheritdoc}
|
Chris@0
|
49 */
|
Chris@0
|
50 public function setFormatter(OutputFormatterInterface $formatter)
|
Chris@0
|
51 {
|
Chris@0
|
52 $this->formatter = $formatter;
|
Chris@0
|
53 }
|
Chris@0
|
54
|
Chris@0
|
55 /**
|
Chris@0
|
56 * {@inheritdoc}
|
Chris@0
|
57 */
|
Chris@0
|
58 public function getFormatter()
|
Chris@0
|
59 {
|
Chris@0
|
60 return $this->formatter;
|
Chris@0
|
61 }
|
Chris@0
|
62
|
Chris@0
|
63 /**
|
Chris@0
|
64 * {@inheritdoc}
|
Chris@0
|
65 */
|
Chris@0
|
66 public function setDecorated($decorated)
|
Chris@0
|
67 {
|
Chris@0
|
68 $this->formatter->setDecorated($decorated);
|
Chris@0
|
69 }
|
Chris@0
|
70
|
Chris@0
|
71 /**
|
Chris@0
|
72 * {@inheritdoc}
|
Chris@0
|
73 */
|
Chris@0
|
74 public function isDecorated()
|
Chris@0
|
75 {
|
Chris@0
|
76 return $this->formatter->isDecorated();
|
Chris@0
|
77 }
|
Chris@0
|
78
|
Chris@0
|
79 /**
|
Chris@0
|
80 * {@inheritdoc}
|
Chris@0
|
81 */
|
Chris@0
|
82 public function setVerbosity($level)
|
Chris@0
|
83 {
|
Chris@0
|
84 $this->verbosity = (int) $level;
|
Chris@0
|
85 }
|
Chris@0
|
86
|
Chris@0
|
87 /**
|
Chris@0
|
88 * {@inheritdoc}
|
Chris@0
|
89 */
|
Chris@0
|
90 public function getVerbosity()
|
Chris@0
|
91 {
|
Chris@0
|
92 return $this->verbosity;
|
Chris@0
|
93 }
|
Chris@0
|
94
|
Chris@0
|
95 /**
|
Chris@0
|
96 * {@inheritdoc}
|
Chris@0
|
97 */
|
Chris@0
|
98 public function isQuiet()
|
Chris@0
|
99 {
|
Chris@0
|
100 return self::VERBOSITY_QUIET === $this->verbosity;
|
Chris@0
|
101 }
|
Chris@0
|
102
|
Chris@0
|
103 /**
|
Chris@0
|
104 * {@inheritdoc}
|
Chris@0
|
105 */
|
Chris@0
|
106 public function isVerbose()
|
Chris@0
|
107 {
|
Chris@0
|
108 return self::VERBOSITY_VERBOSE <= $this->verbosity;
|
Chris@0
|
109 }
|
Chris@0
|
110
|
Chris@0
|
111 /**
|
Chris@0
|
112 * {@inheritdoc}
|
Chris@0
|
113 */
|
Chris@0
|
114 public function isVeryVerbose()
|
Chris@0
|
115 {
|
Chris@0
|
116 return self::VERBOSITY_VERY_VERBOSE <= $this->verbosity;
|
Chris@0
|
117 }
|
Chris@0
|
118
|
Chris@0
|
119 /**
|
Chris@0
|
120 * {@inheritdoc}
|
Chris@0
|
121 */
|
Chris@0
|
122 public function isDebug()
|
Chris@0
|
123 {
|
Chris@0
|
124 return self::VERBOSITY_DEBUG <= $this->verbosity;
|
Chris@0
|
125 }
|
Chris@0
|
126
|
Chris@0
|
127 /**
|
Chris@0
|
128 * {@inheritdoc}
|
Chris@0
|
129 */
|
Chris@0
|
130 public function writeln($messages, $options = self::OUTPUT_NORMAL)
|
Chris@0
|
131 {
|
Chris@0
|
132 $this->write($messages, true, $options);
|
Chris@0
|
133 }
|
Chris@0
|
134
|
Chris@0
|
135 /**
|
Chris@0
|
136 * {@inheritdoc}
|
Chris@0
|
137 */
|
Chris@0
|
138 public function write($messages, $newline = false, $options = self::OUTPUT_NORMAL)
|
Chris@0
|
139 {
|
Chris@0
|
140 $messages = (array) $messages;
|
Chris@0
|
141
|
Chris@0
|
142 $types = self::OUTPUT_NORMAL | self::OUTPUT_RAW | self::OUTPUT_PLAIN;
|
Chris@0
|
143 $type = $types & $options ?: self::OUTPUT_NORMAL;
|
Chris@0
|
144
|
Chris@0
|
145 $verbosities = self::VERBOSITY_QUIET | self::VERBOSITY_NORMAL | self::VERBOSITY_VERBOSE | self::VERBOSITY_VERY_VERBOSE | self::VERBOSITY_DEBUG;
|
Chris@0
|
146 $verbosity = $verbosities & $options ?: self::VERBOSITY_NORMAL;
|
Chris@0
|
147
|
Chris@0
|
148 if ($verbosity > $this->getVerbosity()) {
|
Chris@0
|
149 return;
|
Chris@0
|
150 }
|
Chris@0
|
151
|
Chris@0
|
152 foreach ($messages as $message) {
|
Chris@0
|
153 switch ($type) {
|
Chris@0
|
154 case OutputInterface::OUTPUT_NORMAL:
|
Chris@0
|
155 $message = $this->formatter->format($message);
|
Chris@0
|
156 break;
|
Chris@0
|
157 case OutputInterface::OUTPUT_RAW:
|
Chris@0
|
158 break;
|
Chris@0
|
159 case OutputInterface::OUTPUT_PLAIN:
|
Chris@0
|
160 $message = strip_tags($this->formatter->format($message));
|
Chris@0
|
161 break;
|
Chris@0
|
162 }
|
Chris@0
|
163
|
Chris@0
|
164 $this->doWrite($message, $newline);
|
Chris@0
|
165 }
|
Chris@0
|
166 }
|
Chris@0
|
167
|
Chris@0
|
168 /**
|
Chris@0
|
169 * Writes a message to the output.
|
Chris@0
|
170 *
|
Chris@0
|
171 * @param string $message A message to write to the output
|
Chris@0
|
172 * @param bool $newline Whether to add a newline or not
|
Chris@0
|
173 */
|
Chris@0
|
174 abstract protected function doWrite($message, $newline);
|
Chris@0
|
175 }
|