ConsoleOutput.php 4.0 KB

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