Class Symfony\Component\Console\Style\SymfonyStyle

InheritanceSymfony\Component\Console\Style\SymfonyStyle » Symfony\Component\Console\Style\OutputStyle
ImplementsSymfony\Component\Console\Output\OutputInterface, Symfony\Component\Console\Style\StyleInterface

Output decorator helpers for the Symfony Style Guide.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Symfony\Component\Console\Style\SymfonyStyle
ask() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
askHidden() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
askQuestion() Symfony\Component\Console\Style\SymfonyStyle
block() Formats a message as a block of text. Symfony\Component\Console\Style\SymfonyStyle
caution() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
choice() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
comment() Formats a command comment. Symfony\Component\Console\Style\SymfonyStyle
confirm() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
createProgressBar() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
error() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
getFormatter() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
getVerbosity() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
isDebug() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
isDecorated() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
isQuiet() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
isVerbose() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
isVeryVerbose() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
listing() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
newLine() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
note() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
progressAdvance() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
progressFinish() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
progressStart() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
section() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
setDecorated() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
setFormatter() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
setVerbosity() {@inheritdoc} Symfony\Component\Console\Style\OutputStyle
success() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
table() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
text() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
title() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
warning() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
write() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle
writeln() {@inheritdoc} Symfony\Component\Console\Style\SymfonyStyle

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
MAX_LINE_LENGTH 120 Symfony\Component\Console\Style\SymfonyStyle

Method Details

__construct() public method

public void __construct ( Symfony\Component\Console\Input\InputInterface $input, Symfony\Component\Console\Output\OutputInterface $output )
$input Symfony\Component\Console\Input\InputInterface
$output Symfony\Component\Console\Output\OutputInterface
ask() public method

{@inheritdoc}

public void ask ( $question, $default null, $validator null )
$question
$default
$validator
askHidden() public method

{@inheritdoc}

public void askHidden ( $question, $validator null )
$question
$validator
askQuestion() public method

public string askQuestion ( Symfony\Component\Console\Question\Question $question )
$question Symfony\Component\Console\Question\Question
block() public method

Formats a message as a block of text.

public void block ( $messages, $type null, $style null, $prefix ' ', $padding false )
$messages string|array

The message to write in the block

$type string|null

The block type (added in [] on first line)

$style string|null

The style to apply to the whole block

$prefix string

The prefix for the block

$padding bool

Whether to add vertical padding

caution() public method

{@inheritdoc}

public void caution ( $message )
$message
choice() public method

{@inheritdoc}

public void choice ( $question, array $choices, $default null )
$question
$choices
$default
comment() public method

Formats a command comment.

public void comment ( $message )
$message string|array
confirm() public method

{@inheritdoc}

public void confirm ( $question, $default true )
$question
$default
createProgressBar() public method

{@inheritdoc}

public void createProgressBar ( $max 0 )
$max
error() public method

{@inheritdoc}

public void error ( $message )
$message
listing() public method

{@inheritdoc}

public void listing ( array $elements )
$elements
newLine() public method

{@inheritdoc}

public void newLine ( $count 1 )
$count
note() public method

{@inheritdoc}

public void note ( $message )
$message
progressAdvance() public method

{@inheritdoc}

public void progressAdvance ( $step 1 )
$step
progressFinish() public method

{@inheritdoc}

public void progressFinish ( )
progressStart() public method

{@inheritdoc}

public void progressStart ( $max 0 )
$max
section() public method

{@inheritdoc}

public void section ( $message )
$message
success() public method

{@inheritdoc}

public void success ( $message )
$message
table() public method

{@inheritdoc}

public void table ( array $headers, array $rows )
$headers
$rows
text() public method

{@inheritdoc}

public void text ( $message )
$message
title() public method

{@inheritdoc}

public void title ( $message )
$message
warning() public method

{@inheritdoc}

public void warning ( $message )
$message
write() public method

{@inheritdoc}

public void write ( $messages, $newline false, $type self::OUTPUT_NORMAL )
$messages
$newline
$type
writeln() public method

{@inheritdoc}

public void writeln ( $messages, $type self::OUTPUT_NORMAL )
$messages
$type