\Symfony\Component\Console\StyleOutputStyle

Decorates output to add console style guide helpers.

Summary

Methods

Properties

Constants

__construct()
newLine()
createProgressBar()
write()
writeln()
setVerbosity()
getVerbosity()
setDecorated()
isDecorated()
setFormatter()
getFormatter()
isQuiet()
isVerbose()
isVeryVerbose()
isDebug()

No public properties found

No constants found

getErrorOutput()

No protected properties found

N/A

No private methods found

$output

N/A

abstract

File: vendor/symfony/console/Style/OutputStyle.php
Package: Default
Class hierarchy: \Symfony\Component\Console\Style\OutputStyle
Implements: \Symfony\Component\Console\Output\OutputInterface; \Symfony\Component\Console\Style\StyleInterface

Properties

$output

$output :

Type

Methods

__construct()

__construct(\Symfony\Component\Console\Output\OutputInterface  $output)

Parameters

\Symfony\Component\Console\Output\OutputInterface

$output

newLine()

newLine(integer  $count = 1)

Add newline(s).

Parameters

integer

$count

The number of newlines

createProgressBar()

createProgressBar(integer  $max) : \Symfony\Component\Console\Helper\ProgressBar

Parameters

integer

$max

Returns

\Symfony\Component\Console\Helper\ProgressBar

write()

write(string|\Symfony\Component\Console\Output\iterable  $messages, boolean  $newline = false,   $type = self::OUTPUT_NORMAL)

Writes a message to the output.

Parameters

string\|\Symfony\Component\Console\Output\iterable	$messages	The message as an iterable of strings or a single string
boolean	$newline	Whether to add a newline
	$type

writeln()

writeln(string|\Symfony\Component\Console\Output\iterable  $messages,   $type = self::OUTPUT_NORMAL)

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

Parameters

string\|\Symfony\Component\Console\Output\iterable	$messages	The message as an iterable of strings or a single string
	$type

setVerbosity()

setVerbosity(integer  $level)

Sets the verbosity of the output.

Parameters

integer

$level

The level of verbosity (one of the VERBOSITY constants)

getVerbosity()

getVerbosity() : integer

Gets the current verbosity of the output.

Returns

integer —

The current level of verbosity (one of the VERBOSITY constants)

setDecorated()

setDecorated(boolean  $decorated)

Sets the decorated flag.

Parameters

boolean

$decorated

Whether to decorate the messages

isDecorated()

isDecorated() : boolean

Gets the decorated flag.

Returns

boolean —

true if the output will decorate messages, false otherwise

setFormatter()

setFormatter(\Symfony\Component\Console\Formatter\OutputFormatterInterface  $formatter)

Parameters

\Symfony\Component\Console\Formatter\OutputFormatterInterface

$formatter

getFormatter()

getFormatter() : \Symfony\Component\Console\Formatter\OutputFormatterInterface

Returns current output formatter instance.

Returns

\Symfony\Component\Console\Formatter\OutputFormatterInterface

isQuiet()

isQuiet() : boolean

Returns whether verbosity is quiet (-q).

Returns

boolean —

true if verbosity is set to VERBOSITY_QUIET, false otherwise

isVerbose()

isVerbose() : boolean

Returns whether verbosity is verbose (-v).

Returns

boolean —

true if verbosity is set to VERBOSITY_VERBOSE, false otherwise

isVeryVerbose()

isVeryVerbose() : boolean

Returns whether verbosity is very verbose (-vv).

Returns

boolean —

true if verbosity is set to VERBOSITY_VERY_VERBOSE, false otherwise

isDebug()

isDebug() : boolean

Returns whether verbosity is debug (-vvv).

Returns

boolean —

true if verbosity is set to VERBOSITY_DEBUG, false otherwise

getErrorOutput()

getErrorOutput()