ConsoleOutput.php 4.2KB

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