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@0
|
14 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
|
Chris@0
|
15
|
Chris@0
|
16 /**
|
Chris@0
|
17 * ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.
|
Chris@0
|
18 *
|
Chris@0
|
19 * This class is a convenient wrapper around `StreamOutput` for both STDOUT and STDERR.
|
Chris@0
|
20 *
|
Chris@0
|
21 * $output = new ConsoleOutput();
|
Chris@0
|
22 *
|
Chris@0
|
23 * This is equivalent to:
|
Chris@0
|
24 *
|
Chris@0
|
25 * $output = new StreamOutput(fopen('php://stdout', 'w'));
|
Chris@0
|
26 * $stdErr = new StreamOutput(fopen('php://stderr', 'w'));
|
Chris@0
|
27 *
|
Chris@0
|
28 * @author Fabien Potencier <fabien@symfony.com>
|
Chris@0
|
29 */
|
Chris@0
|
30 class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
|
Chris@0
|
31 {
|
Chris@0
|
32 private $stderr;
|
Chris@0
|
33
|
Chris@0
|
34 /**
|
Chris@0
|
35 * @param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
|
Chris@0
|
36 * @param bool|null $decorated Whether to decorate messages (null for auto-guessing)
|
Chris@0
|
37 * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
|
Chris@0
|
38 */
|
Chris@0
|
39 public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = null, OutputFormatterInterface $formatter = null)
|
Chris@0
|
40 {
|
Chris@0
|
41 parent::__construct($this->openOutputStream(), $verbosity, $decorated, $formatter);
|
Chris@0
|
42
|
Chris@0
|
43 $actualDecorated = $this->isDecorated();
|
Chris@0
|
44 $this->stderr = new StreamOutput($this->openErrorStream(), $verbosity, $decorated, $this->getFormatter());
|
Chris@0
|
45
|
Chris@0
|
46 if (null === $decorated) {
|
Chris@0
|
47 $this->setDecorated($actualDecorated && $this->stderr->isDecorated());
|
Chris@0
|
48 }
|
Chris@0
|
49 }
|
Chris@0
|
50
|
Chris@0
|
51 /**
|
Chris@0
|
52 * {@inheritdoc}
|
Chris@0
|
53 */
|
Chris@0
|
54 public function setDecorated($decorated)
|
Chris@0
|
55 {
|
Chris@0
|
56 parent::setDecorated($decorated);
|
Chris@0
|
57 $this->stderr->setDecorated($decorated);
|
Chris@0
|
58 }
|
Chris@0
|
59
|
Chris@0
|
60 /**
|
Chris@0
|
61 * {@inheritdoc}
|
Chris@0
|
62 */
|
Chris@0
|
63 public function setFormatter(OutputFormatterInterface $formatter)
|
Chris@0
|
64 {
|
Chris@0
|
65 parent::setFormatter($formatter);
|
Chris@0
|
66 $this->stderr->setFormatter($formatter);
|
Chris@0
|
67 }
|
Chris@0
|
68
|
Chris@0
|
69 /**
|
Chris@0
|
70 * {@inheritdoc}
|
Chris@0
|
71 */
|
Chris@0
|
72 public function setVerbosity($level)
|
Chris@0
|
73 {
|
Chris@0
|
74 parent::setVerbosity($level);
|
Chris@0
|
75 $this->stderr->setVerbosity($level);
|
Chris@0
|
76 }
|
Chris@0
|
77
|
Chris@0
|
78 /**
|
Chris@0
|
79 * {@inheritdoc}
|
Chris@0
|
80 */
|
Chris@0
|
81 public function getErrorOutput()
|
Chris@0
|
82 {
|
Chris@0
|
83 return $this->stderr;
|
Chris@0
|
84 }
|
Chris@0
|
85
|
Chris@0
|
86 /**
|
Chris@0
|
87 * {@inheritdoc}
|
Chris@0
|
88 */
|
Chris@0
|
89 public function setErrorOutput(OutputInterface $error)
|
Chris@0
|
90 {
|
Chris@0
|
91 $this->stderr = $error;
|
Chris@0
|
92 }
|
Chris@0
|
93
|
Chris@0
|
94 /**
|
Chris@0
|
95 * Returns true if current environment supports writing console output to
|
Chris@0
|
96 * STDOUT.
|
Chris@0
|
97 *
|
Chris@0
|
98 * @return bool
|
Chris@0
|
99 */
|
Chris@0
|
100 protected function hasStdoutSupport()
|
Chris@0
|
101 {
|
Chris@0
|
102 return false === $this->isRunningOS400();
|
Chris@0
|
103 }
|
Chris@0
|
104
|
Chris@0
|
105 /**
|
Chris@0
|
106 * Returns true if current environment supports writing console output to
|
Chris@0
|
107 * STDERR.
|
Chris@0
|
108 *
|
Chris@0
|
109 * @return bool
|
Chris@0
|
110 */
|
Chris@0
|
111 protected function hasStderrSupport()
|
Chris@0
|
112 {
|
Chris@0
|
113 return false === $this->isRunningOS400();
|
Chris@0
|
114 }
|
Chris@0
|
115
|
Chris@0
|
116 /**
|
Chris@0
|
117 * Checks if current executing environment is IBM iSeries (OS400), which
|
Chris@0
|
118 * doesn't properly convert character-encodings between ASCII to EBCDIC.
|
Chris@0
|
119 *
|
Chris@0
|
120 * @return bool
|
Chris@0
|
121 */
|
Chris@0
|
122 private function isRunningOS400()
|
Chris@0
|
123 {
|
Chris@17
|
124 $checks = [
|
Chris@17
|
125 \function_exists('php_uname') ? php_uname('s') : '',
|
Chris@0
|
126 getenv('OSTYPE'),
|
Chris@0
|
127 PHP_OS,
|
Chris@17
|
128 ];
|
Chris@0
|
129
|
Chris@0
|
130 return false !== stripos(implode(';', $checks), 'OS400');
|
Chris@0
|
131 }
|
Chris@0
|
132
|
Chris@0
|
133 /**
|
Chris@0
|
134 * @return resource
|
Chris@0
|
135 */
|
Chris@0
|
136 private function openOutputStream()
|
Chris@0
|
137 {
|
Chris@0
|
138 if (!$this->hasStdoutSupport()) {
|
Chris@0
|
139 return fopen('php://output', 'w');
|
Chris@0
|
140 }
|
Chris@0
|
141
|
Chris@0
|
142 return @fopen('php://stdout', 'w') ?: fopen('php://output', 'w');
|
Chris@0
|
143 }
|
Chris@0
|
144
|
Chris@0
|
145 /**
|
Chris@0
|
146 * @return resource
|
Chris@0
|
147 */
|
Chris@0
|
148 private function openErrorStream()
|
Chris@0
|
149 {
|
Chris@0
|
150 return fopen($this->hasStderrSupport() ? 'php://stderr' : 'php://output', 'w');
|
Chris@0
|
151 }
|
Chris@0
|
152 }
|