PHPFUI/InstaDoc
 
Copied!

OutputInterface is the interface implemented by all Output classes.

AbstractInterface
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_SILENT = 8
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERBOSE = 64
public Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERY_VERBOSE = 128
Methods
public abstract getFormatter() : Symfony\Component\Console\Formatter\OutputFormatterInterface
 

Returns current output formatter instance.

public abstract getVerbosity() : int
 

Gets the current verbosity of the output.

  • return self::VERBOSITY_*
public abstract isDebug() : bool
 

Returns whether verbosity is debug (-vvv).

public abstract isDecorated() : bool
 

Gets the decorated flag.

public abstract isQuiet() : bool
 

Returns whether verbosity is quiet (-q).

public abstract isVerbose() : bool
 

Returns whether verbosity is verbose (-v).

public abstract isVeryVerbose() : bool
 

Returns whether verbosity is very verbose (-vv).

public abstract setDecorated(bool $decorated) : void
 

Sets the decorated flag.

public abstract setFormatter(Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter) : void
public abstract setVerbosity(int $level) : void
 

Sets the verbosity of the output.

  • param self::VERBOSITY_* $level
public abstract write(Traversable|array|string $messages, bool $newline = false, int $options = 0) : void
 

Writes a message to the output.

  • param bool $newline Whether to add a newline
  • param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
public abstract writeln(Traversable|array|string $messages, int $options = 0) : void
 

Writes a message to the output and adds a newline at the end.

  • param int $options A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL | self::VERBOSITY_NORMAL
© 2025 Bruce Wells