OutputStyle

class OutputStyle extends SymfonyStyle implements NewLineAware (View source)

Properties

protected bool $newLineWritten

If the last output written wrote a new line.

Methods

void __construct(InputInterface $input, OutputInterface $output)

Create a new Console OutputStyle instance.
void write(string|iterable $messages, bool $newline = false, int $options = 0)

{@inheritdoc}
void writeln(string|iterable $messages, int $type = self::OUTPUT_NORMAL)

{@inheritdoc}
void newLine(int $count = 1)

{@inheritdoc}
bool newLineWritten()

Whether a newline has already been written.
bool isQuiet()

Returns whether verbosity is quiet (-q).
bool isVerbose()

Returns whether verbosity is verbose (-v).
bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).
bool isDebug()

Returns whether verbosity is debug (-vvv).
OutputInterface getOutput()

Get the underlying Symfony output implementation.

Details

void __construct(InputInterface $input, OutputInterface $output)

Create a new Console OutputStyle instance.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

void write(string|iterable $messages, bool $newline = false, int $options = 0)

{@inheritdoc}

Parameters

string|iterable $messages
bool $newline
int $options

Return Value

void

void writeln(string|iterable $messages, int $type = self::OUTPUT_NORMAL)

{@inheritdoc}

Parameters

string|iterable $messages
int $type

Return Value

void

void newLine(int $count = 1)

{@inheritdoc}

Parameters

int $count

Return Value

void

bool newLineWritten()

Whether a newline has already been written.

Return Value

bool

bool isQuiet()

Returns whether verbosity is quiet (-q).

Return Value

bool

bool isVerbose()

Returns whether verbosity is verbose (-v).

Return Value

bool

bool isVeryVerbose()

Returns whether verbosity is very verbose (-vv).

Return Value

bool

bool isDebug()

Returns whether verbosity is debug (-vvv).

Return Value

bool

OutputInterface getOutput()

Get the underlying Symfony output implementation.

Return Value

OutputInterface

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Console/OutputStyle.html