StreamOutput.php 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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\Exception\InvalidArgumentException;
  12. use Symfony\Component\Console\Exception\RuntimeException;
  13. use Symfony\Component\Console\Formatter\OutputFormatterInterface;
  14. /**
  15. * StreamOutput writes the output to a given stream.
  16. *
  17. * Usage:
  18. *
  19. * $output = new StreamOutput(fopen('php://stdout', 'w'));
  20. *
  21. * As `StreamOutput` can use any stream, you can also use a file:
  22. *
  23. * $output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
  24. *
  25. * @author Fabien Potencier <fabien@symfony.com>
  26. */
  27. class StreamOutput extends Output
  28. {
  29. private $stream;
  30. /**
  31. * Constructor.
  32. *
  33. * @param resource $stream A stream resource
  34. * @param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
  35. * @param bool|null $decorated Whether to decorate messages (null for auto-guessing)
  36. * @param OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
  37. *
  38. * @throws InvalidArgumentException When first argument is not a real stream
  39. */
  40. public function __construct($stream, $verbosity = self::VERBOSITY_NORMAL, $decorated = null, OutputFormatterInterface $formatter = null)
  41. {
  42. if (!is_resource($stream) || 'stream' !== get_resource_type($stream)) {
  43. throw new InvalidArgumentException('The StreamOutput class needs a stream as its first argument.');
  44. }
  45. $this->stream = $stream;
  46. if (null === $decorated) {
  47. $decorated = $this->hasColorSupport();
  48. }
  49. parent::__construct($verbosity, $decorated, $formatter);
  50. }
  51. /**
  52. * Gets the stream attached to this StreamOutput instance.
  53. *
  54. * @return resource A stream resource
  55. */
  56. public function getStream()
  57. {
  58. return $this->stream;
  59. }
  60. /**
  61. * {@inheritdoc}
  62. */
  63. protected function doWrite($message, $newline)
  64. {
  65. if (false === @fwrite($this->stream, $message) || ($newline && (false === @fwrite($this->stream, PHP_EOL)))) {
  66. // should never happen
  67. throw new RuntimeException('Unable to write output.');
  68. }
  69. fflush($this->stream);
  70. }
  71. /**
  72. * Returns true if the stream supports colorization.
  73. *
  74. * Colorization is disabled if not supported by the stream:
  75. *
  76. * - Windows != 10.0.10586 without Ansicon, ConEmu or Mintty
  77. * - non tty consoles
  78. *
  79. * @return bool true if the stream supports colorization, false otherwise
  80. */
  81. protected function hasColorSupport()
  82. {
  83. if (DIRECTORY_SEPARATOR === '\\') {
  84. return
  85. '10.0.10586' === PHP_WINDOWS_VERSION_MAJOR.'.'.PHP_WINDOWS_VERSION_MINOR.'.'.PHP_WINDOWS_VERSION_BUILD
  86. || false !== getenv('ANSICON')
  87. || 'ON' === getenv('ConEmuANSI')
  88. || 'xterm' === getenv('TERM');
  89. }
  90. return function_exists('posix_isatty') && @posix_isatty($this->stream);
  91. }
  92. }