PHPFUI/InstaDoc
 
Copied!

StreamOutput writes the output to a given stream.

Usage:

$output = new StreamOutput(fopen('php://stdout', 'w'));

As StreamOutput can use any stream, you can also use a file:

$output = new StreamOutput(fopen('/path/to/output.log', 'a', false));
CloneableInstantiable
Constants
public Symfony\Component\Console\Output\OutputInterface::OUTPUT_NORMAL = 1
public Symfony\Component\Console\Output\OutputInterface::OUTPUT_PLAIN = 4
public Symfony\Component\Console\Output\OutputInterface::OUTPUT_RAW = 2
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_DEBUG = 256
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_NORMAL = 32
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_QUIET = 16
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERBOSE = 64
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERY_VERBOSE = 128
Methods
public __construct( $stream, int $verbosity = 32self::VERBOSITY_NORMAL, ?bool $decorated = NULL, ?Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter = NULL)
 
  • param resource $stream A stream resource
  • param int $verbosity The verbosity level (one of the VERBOSITY constants in OutputInterface)
  • param bool|null $decorated Whether to decorate messages (null for auto-guessing)
  • param \OutputFormatterInterface|null $formatter Output formatter instance (null to use default OutputFormatter)
  • throws \InvalidArgumentException When first argument is not a real stream
public Symfony\Component\Console\Output\Output::getFormatter() : Symfony\Component\Console\Formatter\OutputFormatterInterface
public getStream()
 

Gets the stream attached to this StreamOutput instance.

  • return resource
public Symfony\Component\Console\Output\Output::getVerbosity() : int
public Symfony\Component\Console\Output\Output::isDebug() : bool
public Symfony\Component\Console\Output\Output::isDecorated() : bool
public Symfony\Component\Console\Output\Output::isQuiet() : bool
public Symfony\Component\Console\Output\Output::isVerbose() : bool
public Symfony\Component\Console\Output\Output::isVeryVerbose() : bool
public Symfony\Component\Console\Output\Output::setDecorated(bool $decorated) : void
public Symfony\Component\Console\Output\Output::setFormatter(Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter) : void
public Symfony\Component\Console\Output\Output::setVerbosity(int $level) : void
public Symfony\Component\Console\Output\Output::write(Traversable|array|string $messages, bool $newline = false, int $options = 1self::OUTPUT_NORMAL) : void
public Symfony\Component\Console\Output\Output::writeln(Traversable|array|string $messages, int $options = 1self::OUTPUT_NORMAL) : void
Methods
protected doWrite(string $message, bool $newline) : void
protected hasColorSupport() : bool
 

Returns true if the stream supports colorization.

Colorization is disabled if not supported by the stream:

This is tricky on Windows, because Cygwin, Msys2 etc emulate pseudo terminals via named pipes, so we can only check the environment.

Reference: Composer\XdebugHandler\Process::supportsColor https://github.com/composer/xdebug-handler

  • return bool true if the stream supports colorization, false otherwise
Properties
private $stream = NULL
 
  • var resource
© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration