ConsoleOutput.php 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  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. /**
  29. * @var StreamOutput
  30. */
  31. private $stderr;
  32. /**
  33. * @param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
  34. * @param bool|null $decorated Whether to decorate messages (null for auto-guessing)
  35. * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
  36. */
  37. public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = null, OutputFormatterInterface $formatter = null)
  38. {
  39. parent::__construct($this->openOutputStream(), $verbosity, $decorated, $formatter);
  40. $actualDecorated = $this->isDecorated();
  41. $this->stderr = new StreamOutput($this->openErrorStream(), $verbosity, $decorated, $this->getFormatter());
  42. if (null === $decorated) {
  43. $this->setDecorated($actualDecorated && $this->stderr->isDecorated());
  44. }
  45. }
  46. /**
  47. * {@inheritdoc}
  48. */
  49. public function setDecorated($decorated)
  50. {
  51. parent::setDecorated($decorated);
  52. $this->stderr->setDecorated($decorated);
  53. }
  54. /**
  55. * {@inheritdoc}
  56. */
  57. public function setFormatter(OutputFormatterInterface $formatter)
  58. {
  59. parent::setFormatter($formatter);
  60. $this->stderr->setFormatter($formatter);
  61. }
  62. /**
  63. * {@inheritdoc}
  64. */
  65. public function setVerbosity($level)
  66. {
  67. parent::setVerbosity($level);
  68. $this->stderr->setVerbosity($level);
  69. }
  70. /**
  71. * {@inheritdoc}
  72. */
  73. public function getErrorOutput()
  74. {
  75. return $this->stderr;
  76. }
  77. /**
  78. * {@inheritdoc}
  79. */
  80. public function setErrorOutput(OutputInterface $error)
  81. {
  82. $this->stderr = $error;
  83. }
  84. /**
  85. * Returns true if current environment supports writing console output to
  86. * STDOUT.
  87. *
  88. * @return bool
  89. */
  90. protected function hasStdoutSupport()
  91. {
  92. return false === $this->isRunningOS400();
  93. }
  94. /**
  95. * Returns true if current environment supports writing console output to
  96. * STDERR.
  97. *
  98. * @return bool
  99. */
  100. protected function hasStderrSupport()
  101. {
  102. return false === $this->isRunningOS400();
  103. }
  104. /**
  105. * Checks if current executing environment is IBM iSeries (OS400), which
  106. * doesn't properly convert character-encodings between ASCII to EBCDIC.
  107. *
  108. * @return bool
  109. */
  110. private function isRunningOS400()
  111. {
  112. $checks = array(
  113. function_exists('php_uname') ? php_uname('s') : '',
  114. getenv('OSTYPE'),
  115. PHP_OS,
  116. );
  117. return false !== stripos(implode(';', $checks), 'OS400');
  118. }
  119. /**
  120. * @return resource
  121. */
  122. private function openOutputStream()
  123. {
  124. if (!$this->hasStdoutSupport()) {
  125. return fopen('php://output', 'w');
  126. }
  127. return @fopen('php://stdout', 'w') ?: fopen('php://output', 'w');
  128. }
  129. /**
  130. * @return resource
  131. */
  132. private function openErrorStream()
  133. {
  134. return fopen($this->hasStderrSupport() ? 'php://stderr' : 'php://output', 'w');
  135. }
  136. }