PHPFUI/InstaDoc
 
Copied!

Decorates output to add console style guide helpers.

Abstract
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 __construct(Symfony\Component\Console\Output\OutputInterface $output)
public abstract Symfony\Component\Console\Style\StyleInterface::ask(string $question, ?string $default = NULL, ?callable $validator = NULL) : ?mixed
 

Asks a question.

public abstract Symfony\Component\Console\Style\StyleInterface::askHidden(string $question, ?callable $validator = NULL) : ?mixed
 

Asks a question with the user input hidden.

public abstract Symfony\Component\Console\Style\StyleInterface::caution(array|string $message) : void
 

Formats a caution admonition.

public abstract Symfony\Component\Console\Style\StyleInterface::choice(string $question, array $choices, ?mixed $default = NULL) : ?mixed
 

Asks a choice question.

public abstract Symfony\Component\Console\Style\StyleInterface::confirm(string $question, bool $default = true) : bool
 

Asks for confirmation.

public createProgressBar(int $max = 0) : Symfony\Component\Console\Helper\ProgressBar
public abstract Symfony\Component\Console\Style\StyleInterface::error(array|string $message) : void
 

Formats an error result bar.

public getFormatter() : Symfony\Component\Console\Formatter\OutputFormatterInterface
public getVerbosity() : int
public isDebug() : bool
public isDecorated() : bool
public isQuiet() : bool
public isSilent() : bool
public isVerbose() : bool
public isVeryVerbose() : bool
public abstract Symfony\Component\Console\Style\StyleInterface::listing(array $elements) : void
 

Formats a list.

public newLine(int $count = 1) : void
public abstract Symfony\Component\Console\Style\StyleInterface::note(array|string $message) : void
 

Formats a note admonition.

public abstract Symfony\Component\Console\Style\StyleInterface::progressAdvance(int $step = 1) : void
 

Advances the progress output X steps.

public abstract Symfony\Component\Console\Style\StyleInterface::progressFinish() : void
 

Finishes the progress output.

public abstract Symfony\Component\Console\Style\StyleInterface::progressStart(int $max = 0) : void
 

Starts the progress output.

public abstract Symfony\Component\Console\Style\StyleInterface::section(string $message) : void
 

Formats a section title.

public setDecorated(bool $decorated) : void
public setFormatter(Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter) : void
public setVerbosity(int $level) : void
public abstract Symfony\Component\Console\Style\StyleInterface::success(array|string $message) : void
 

Formats a success result bar.

public abstract Symfony\Component\Console\Style\StyleInterface::table(array $headers, array $rows) : void
 

Formats a table.

public abstract Symfony\Component\Console\Style\StyleInterface::text(array|string $message) : void
 

Formats informational text.

public abstract Symfony\Component\Console\Style\StyleInterface::title(string $message) : void
 

Formats a command title.

public abstract Symfony\Component\Console\Style\StyleInterface::warning(array|string $message) : void
 

Formats an warning result bar.

public write(Traversable|array|string $messages, bool $newline = false, int $type = 1self::OUTPUT_NORMAL) : void
public writeln(Traversable|array|string $messages, int $type = 1self::OUTPUT_NORMAL) : void
Methods
protected getErrorOutput() : Symfony\Component\Console\Output\OutputInterface
© 2025 Bruce Wells