Interface Symfony\Component\Console\Style\StyleInterface

Implemented bySymfony\Component\Console\Style\OutputStyle, Symfony\Component\Console\Style\SymfonyStyle

Output style helpers.

Public Methods

Hide inherited methods

MethodDescriptionDefined By
ask() Asks a question. Symfony\Component\Console\Style\StyleInterface
askHidden() Asks a question with the user input hidden. Symfony\Component\Console\Style\StyleInterface
caution() Formats a caution admonition. Symfony\Component\Console\Style\StyleInterface
choice() Asks a choice question. Symfony\Component\Console\Style\StyleInterface
confirm() Asks for confirmation. Symfony\Component\Console\Style\StyleInterface
error() Formats an error result bar. Symfony\Component\Console\Style\StyleInterface
listing() Formats a list. Symfony\Component\Console\Style\StyleInterface
newLine() Add newline(s). Symfony\Component\Console\Style\StyleInterface
note() Formats a note admonition. Symfony\Component\Console\Style\StyleInterface
progressAdvance() Advances the progress output X steps. Symfony\Component\Console\Style\StyleInterface
progressFinish() Finishes the progress output. Symfony\Component\Console\Style\StyleInterface
progressStart() Starts the progress output. Symfony\Component\Console\Style\StyleInterface
section() Formats a section title. Symfony\Component\Console\Style\StyleInterface
success() Formats a success result bar. Symfony\Component\Console\Style\StyleInterface
table() Formats a table. Symfony\Component\Console\Style\StyleInterface
text() Formats informational text. Symfony\Component\Console\Style\StyleInterface
title() Formats a command title. Symfony\Component\Console\Style\StyleInterface
warning() Formats an warning result bar. Symfony\Component\Console\Style\StyleInterface

Method Details

ask() public abstract method

Asks a question.

public abstract string ask ( $question, $default null, $validator null )
$question string
$default string|null
$validator callable|null
askHidden() public abstract method

Asks a question with the user input hidden.

public abstract string askHidden ( $question, $validator null )
$question string
$validator callable|null
caution() public abstract method

Formats a caution admonition.

public abstract void caution ( $message )
$message string|array
choice() public abstract method

Asks a choice question.

public abstract string choice ( $question, array $choices, $default null )
$question string
$choices array
$default string|int|null
confirm() public abstract method

Asks for confirmation.

public abstract bool confirm ( $question, $default true )
$question string
$default bool
error() public abstract method

Formats an error result bar.

public abstract void error ( $message )
$message string|array
listing() public abstract method

Formats a list.

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

Add newline(s).

public abstract void newLine ( $count 1 )
$count int

The number of newlines

note() public abstract method

Formats a note admonition.

public abstract void note ( $message )
$message string|array
progressAdvance() public abstract method

Advances the progress output X steps.

public abstract void progressAdvance ( $step 1 )
$step int

Number of steps to advance

progressFinish() public abstract method

Finishes the progress output.

public abstract void progressFinish ( )
progressStart() public abstract method

Starts the progress output.

public abstract void progressStart ( $max 0 )
$max int

Maximum steps (0 if unknown)

section() public abstract method

Formats a section title.

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

Formats a success result bar.

public abstract void success ( $message )
$message string|array
table() public abstract method

Formats a table.

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

Formats informational text.

public abstract void text ( $message )
$message string|array
title() public abstract method

Formats a command title.

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

Formats an warning result bar.

public abstract void warning ( $message )
$message string|array