1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: <?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\Api\IO;
use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Formatter\Formatter;
use Webmozart\Console\Api\Formatter\Style;
use Webmozart\Console\Formatter\AnsiFormatter;
use Webmozart\Console\Formatter\NullFormatter;
/**
* The console output.
*
* This class wraps an output stream and adds convenience functionality for
* writing that stream.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class Output implements Formatter
{
/**
* @var OutputStream
*/
private $stream;
/**
* @var bool
*/
private $quiet = false;
/**
* @var int
*/
private $verbosity = 0;
/**
* @var Formatter
*/
private $formatter;
/**
* @var bool
*/
private $formatOutput;
/**
* Creates an output for the given output stream.
*
* @param OutputStream $stream The output stream.
* @param Formatter|null $formatter The formatter for formatting text
* written to the output stream.
*/
public function __construct(OutputStream $stream, Formatter $formatter = null)
{
$this->stream = $stream;
$this->setFormatter($formatter ?: new NullFormatter());
}
/**
* Writes a string to the output stream.
*
* The string is formatted before it is written to the output stream.
*
* @param string $string The string to write.
* @param int $flags The flags. If one of of {@link IO::VERBOSE},
* {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is
* passed, the output is only written if the
* verbosity level is the given level or higher.
*
* @throws IOException If writing fails or if the output stream is closed.
*/
public function write($string, $flags = null)
{
if ($this->mayWrite($flags)) {
$formatted = $this->formatOutput ? $this->format($string) : $this->removeFormat($string);
$this->stream->write($formatted);
}
}
/**
* Writes a line of text to the output stream.
*
* The string is formatted before it is written to the output stream.
*
* @param string $string The string to write. A newline is appended.
* @param int $flags The flags. If one of of {@link IO::VERBOSE},
* {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is
* passed, the output is only written if the
* verbosity level is the given level or higher.
*
* @throws IOException If writing fails or if the output stream is closed.
*/
public function writeLine($string, $flags = null)
{
if ($this->mayWrite($flags)) {
$string = rtrim($string, PHP_EOL);
$formatted = $this->formatOutput ? $this->format($string) : $this->removeFormat($string);
$this->stream->write($formatted.PHP_EOL);
}
}
/**
* Writes a string to the output stream without formatting.
*
* @param string $string The string to write.
* @param int $flags The flags. If one of of {@link IO::VERBOSE},
* {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is
* passed, the output is only written if the
* verbosity level is the given level or higher.
*
* @throws IOException If writing fails or if the output stream is closed.
*/
public function writeRaw($string, $flags = null)
{
if ($this->mayWrite($flags)) {
$this->stream->write($string);
}
}
/**
* Writes a line of text to the output stream without formatting.
*
* @param string $string The string to write. A newline is appended.
* @param int $flags The flags. If one of of {@link IO::VERBOSE},
* {@link IO::VERY_VERBOSE} and {@link IO::DEBUG} is
* passed, the output is only written if the
* verbosity level is the given level or higher.
*
* @throws IOException If writing fails or if the standard output is closed.
*/
public function writeLineRaw($string, $flags = null)
{
if ($this->mayWrite($flags)) {
$this->stream->write(rtrim($string, PHP_EOL).PHP_EOL);
}
}
/**
* Forces all pending text to be written out.
*
* @throws IOException If flushing fails or if the output stream is closed.
*/
public function flush()
{
$this->stream->flush();
}
/**
* Closes the output.
*/
public function close()
{
$this->stream->close();
}
/**
* Returns whether the output is closed.
*
* @return bool Returns `true` if the output is closed and `false`
* otherwise.
*/
public function isClosed()
{
return $this->stream->isClosed();
}
/**
* Sets the underlying stream.
*
* @param OutputStream $stream The output stream.
*/
public function setStream(OutputStream $stream)
{
$this->stream = $stream;
$this->formatOutput = $stream->supportsAnsi() || !($this->formatter instanceof AnsiFormatter);
}
/**
* Returns the underlying stream.
*
* @return OutputStream The output stream.
*/
public function getStream()
{
return $this->stream;
}
/**
* Sets the output formatter.
*
* @param Formatter $formatter The output formatter.
*/
public function setFormatter(Formatter $formatter)
{
$this->formatter = $formatter;
$this->formatOutput = $this->stream->supportsAnsi() || !($formatter instanceof AnsiFormatter);
}
/**
* Returns the output formatter.
*
* @return Formatter The output formatter.
*/
public function getFormatter()
{
return $this->formatter;
}
/**
* Sets the verbosity level of the output.
*
* @param int $verbosity One of the constants {@link NORMAL}, {@link VERBOSE},
* {@link VERY_VERBOSE} or {@link DEBUG}. Only output
* with the given verbosity level or smaller will be
* written out.
*/
public function setVerbosity($verbosity)
{
Assert::oneOf($verbosity, array(IO::NORMAL, IO::VERBOSE, IO::VERY_VERBOSE, IO::DEBUG), 'The verbosity must be one of IO::NORMAL, IO::VERBOSE, IO::VERY_VERBOSE and IO::DEBUG.');
$this->verbosity = (int) $verbosity;
}
/**
* Returns the current verbosity level.
*
* @return int One of the verbosity constants.
*/
public function getVerbosity()
{
return $this->verbosity;
}
/**
* Returns whether the verbosity level is {@link IO::VERBOSE} or greater.
*
* @return bool Returns `true` if the verbosity level is {@link IO::VERBOSE}
* or greater and `false` otherwise.
*/
public function isVerbose()
{
return $this->verbosity >= IO::VERBOSE;
}
/**
* Returns whether the verbosity level is {@link IO::VERY_VERBOSE} or greater.
*
* @return bool Returns `true` if the verbosity level is
* {@link IO::VERY_VERBOSE} or greater and `false` otherwise.
*/
public function isVeryVerbose()
{
return $this->verbosity >= IO::VERY_VERBOSE;
}
/**
* Returns whether the verbosity level is {@link IO::DEBUG}.
*
* @return bool Returns `true` if the verbosity level is {@link IO::DEBUG}
* and `false` otherwise.
*/
public function isDebug()
{
return IO::DEBUG === $this->verbosity;
}
/**
* Sets whether output should be suppressed completely.
*
* @param bool $quiet Pass `true` to suppress all output and `false`
* otherwise.
*/
public function setQuiet($quiet)
{
$this->quiet = (bool) $quiet;
}
/**
* Returns whether output is suppressed completely.
*
* @return bool Returns `true` if all output is suppressed and `false`
* otherwise.
*/
public function isQuiet()
{
return $this->quiet;
}
/**
* {@inheritdoc}
*/
public function format($string, Style $style = null)
{
return $this->formatter->format($string, $style);
}
/**
* {@inheritdoc}
*/
public function removeFormat($string)
{
return $this->formatter->removeFormat($string);
}
/**
* Returns whether an output may be written for the given flags.
*
* @param int $flags The flags.
*
* @return bool Returns `true` if the output may be written and `false`
* otherwise.
*/
protected function mayWrite($flags)
{
if ($this->quiet) {
return false;
}
if ($flags & IO::VERBOSE) {
return $this->verbosity >= IO::VERBOSE;
}
if ($flags & IO::VERY_VERBOSE) {
return $this->verbosity >= IO::VERY_VERBOSE;
}
if ($flags & IO::DEBUG) {
return $this->verbosity >= IO::DEBUG;
}
return true;
}
}