Graphe d'héritage de SymfonyStyle:

Fonctions membres publiques
	__construct (InputInterface $input, OutputInterface $output)

	block ($messages, string $type=null, string $style=null, string $prefix=' ', bool $padding=false, bool $escape=true)

	title (string $message)

	section (string $message)

	listing (array $elements)

	text ($message)

	comment ($message)

	success ($message)

	error ($message)

	warning ($message)

	note ($message)

	info ($message)

	caution ($message)

	table (array $headers, array $rows)

	horizontalTable (array $headers, array $rows)

	definitionList (... $list)

	ask (string $question, string $default=null, callable $validator=null)

	askHidden (string $question, callable $validator=null)

	confirm (string $question, bool $default=true)

	choice (string $question, array $choices, $default=null)

	progressStart (int $max=0)

	progressAdvance (int $step=1)

	progressFinish ()

	createProgressBar (int $max=0)

	progressIterate (iterable $iterable, int $max=null)

	askQuestion (Question $question)

	writeln ($messages, int $type=self::OUTPUT_NORMAL)

	write ($messages, bool $newline=false, int $type=self::OUTPUT_NORMAL)

	newLine (int $count=1)

	getErrorStyle ()

	createTable ()

Fonctions membres publiques hérités de OutputStyle
	__construct (OutputInterface $output)

	newLine (int $count=1)

	createProgressBar (int $max=0)

	write ($messages, bool $newline=false, int $type=self::OUTPUT_NORMAL)

	writeln ($messages, int $type=self::OUTPUT_NORMAL)

	setVerbosity (int $level)

	getVerbosity ()

	setDecorated (bool $decorated)

	isDecorated ()

	setFormatter (OutputFormatterInterface $formatter)

	getFormatter ()

	isQuiet ()

	isVerbose ()

	isVeryVerbose ()

	isDebug ()

Champs de données
const	MAX_LINE_LENGTH = 120

Champs de données hérités de OutputInterface
const	VERBOSITY_QUIET = 16

const	VERBOSITY_NORMAL = 32

const	VERBOSITY_VERBOSE = 64

const	VERBOSITY_VERY_VERBOSE = 128

const	VERBOSITY_DEBUG = 256

const	OUTPUT_NORMAL = 1

const	OUTPUT_RAW = 2

const	OUTPUT_PLAIN = 4

Fonctions membres privées
	getProgressBar ()

	autoPrependBlock ()

	autoPrependText ()

	writeBuffer (string $message, bool $newLine, int $type)

	createBlock (iterable $messages, string $type=null, string $style=null, string $prefix=' ', bool $padding=false, bool $escape=false)

Attributs privés
	$input

	$output

	$questionHelper

	$progressBar

	$lineLength

	$bufferedOutput

Membres hérités additionnels
Fonctions membres protégées hérités de OutputStyle
	getErrorOutput ()

Description détaillée

Output decorator helpers for the Symfony Style Guide.

Auteur: Kevin Bond kevin.nosp@m.bond.nosp@m.@gmai.nosp@m.l.co.nosp@m.m

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	InputInterface	$input,
		OutputInterface	$output
	)

Références SymfonyStyle\$input, SymfonyStyle\$output, $width, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ ask()

ask	(	string	$question,
		string	$default = `null`,
		callable	$validator = `null`
	)

{Asks a question.

Renvoie: mixed

}

Implémente StyleInterface.

Références $default, et SymfonyStyle\askQuestion().

◆ askHidden()

askHidden	(	string	$question,
		callable	$validator = `null`
	)

{Asks a question with the user input hidden.

Renvoie: mixed

}

Implémente StyleInterface.

Références SymfonyStyle\askQuestion().

◆ askQuestion()

askQuestion ( Question $question )

Renvoie: mixed

Références $this, SymfonyStyle\autoPrependBlock(), et SymfonyStyle\newLine().

Référencé par SymfonyStyle\ask(), SymfonyStyle\askHidden(), SymfonyStyle\choice(), et SymfonyStyle\confirm().

◆ autoPrependBlock()

autoPrependBlock ( )

private

Références SymfonyStyle\newLine().

Référencé par SymfonyStyle\askQuestion(), SymfonyStyle\block(), SymfonyStyle\section(), et SymfonyStyle\title().

◆ autoPrependText()

autoPrependText ( )

private

Références SymfonyStyle\newLine().

Référencé par SymfonyStyle\listing(), et SymfonyStyle\text().

◆ block()

block	(		$messages,
		string	$type = `null`,
		string	$style = `null`,
		string	$prefix = `' '`,
		bool	$padding = `false`,
		bool	$escape = `true`
	)

Formats a message as a block of text.

Paramètres

string | array $messages The message to write in the block

Références $messages, $prefix, $style, $type, SymfonyStyle\autoPrependBlock(), SymfonyStyle\createBlock(), SymfonyStyle\newLine(), et SymfonyStyle\writeln().

Référencé par SymfonyStyle\caution(), SymfonyStyle\comment(), SymfonyStyle\error(), SymfonyStyle\info(), SymfonyStyle\note(), SymfonyStyle\success(), et SymfonyStyle\warning().

◆ caution()

caution ( $message )

{Formats a caution admonition.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, et SymfonyStyle\block().

◆ choice()

choice	(	string	$question,
		array	$choices,
			$default = `null`
	)

{Asks a choice question.

Paramètres

string | int | null $default

Renvoie: mixed

}

Implémente StyleInterface.

Références $default, SymfonyStyle\askQuestion(), et null.

◆ comment()

comment ( $message )

Formats a command comment.

Paramètres

string | array $message

Références $message, SymfonyStyle\block(), et null.

Référencé par LintCommand\displayTxt().

◆ confirm()

confirm	(	string	$question,
		bool	$default = `true`
	)

{Asks for confirmation.

Renvoie: bool

}

Implémente StyleInterface.

Références $default, et SymfonyStyle\askQuestion().

◆ createBlock()

createBlock	(	iterable	$messages,
		string	$type = `null`,
		string	$style = `null`,
		string	$prefix = `' '`,
		bool	$padding = `false`,
		bool	$escape = `false`
	)

private

Références $i, $key, $message, $messages, $prefix, $style, $type, OutputFormatter\escape(), OutputStyle\getFormatter(), OutputStyle\isDecorated(), null, Helper\removeDecoration(), et Helper\width().

Référencé par SymfonyStyle\block().

◆ createProgressBar()

createProgressBar ( int $max = 0 )

{}

Références SymfonyStyle\$progressBar.

Référencé par SymfonyStyle\progressIterate(), et SymfonyStyle\progressStart().

◆ createTable()

createTable ( )

Références SymfonyStyle\$output, $style, Table\getStyleDefinition(), et ConsoleOutputInterface\section().

Référencé par SymfonyStyle\horizontalTable(), et SymfonyStyle\table().

◆ definitionList()

definitionList ( $list )

Formats a list of key/value horizontally.

Each row can be one of:

'A title'
['key' => 'value']
new TableSeparator()

Paramètres

string|array|TableSeparator ...$list

Références $list, $value, SymfonyStyle\horizontalTable(), et null.

◆ error()

error ( $message )

{Formats an error result bar.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, et SymfonyStyle\block().

◆ getErrorStyle()

getErrorStyle ( )

Returns a new instance which makes use of stderr if available.

Renvoie: self

Références SymfonyStyle\$input, et OutputStyle\getErrorOutput().

◆ getProgressBar()

getProgressBar ( )

private

Références SymfonyStyle\$progressBar.

Référencé par SymfonyStyle\progressAdvance(), et SymfonyStyle\progressFinish().

◆ horizontalTable()

horizontalTable	(	array	$headers,
		array	$rows
	)

Formats a horizontal table.

Références $rows, SymfonyStyle\createTable(), et SymfonyStyle\newLine().

Référencé par SymfonyStyle\definitionList().

◆ info()

info ( $message )

Formats an info message.

Paramètres

string | array $message

Références $message, et SymfonyStyle\block().

◆ listing()

listing ( array $elements )

{Formats a list.}

Implémente StyleInterface.

Références SymfonyStyle\autoPrependText(), SymfonyStyle\newLine(), et SymfonyStyle\writeln().

◆ newLine()

newLine ( int $count = 1 )

{Add newline(s).}

Implémente StyleInterface.

Références $count.

Référencé par SymfonyStyle\askQuestion(), SymfonyStyle\autoPrependBlock(), SymfonyStyle\autoPrependText(), SymfonyStyle\block(), SymfonyStyle\horizontalTable(), SymfonyStyle\listing(), SymfonyStyle\progressFinish(), SymfonyStyle\progressIterate(), SymfonyStyle\section(), SymfonyStyle\table(), et SymfonyStyle\title().

◆ note()

note ( $message )

{Formats a note admonition.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, et SymfonyStyle\block().

◆ progressAdvance()

progressAdvance ( int $step = 1 )

{Advances the progress output X steps.}

Implémente StyleInterface.

Références $step, et SymfonyStyle\getProgressBar().

◆ progressFinish()

progressFinish ( )

{Finishes the progress output.}

Implémente StyleInterface.

Références SymfonyStyle\getProgressBar(), SymfonyStyle\newLine(), et null.

◆ progressIterate()

progressIterate	(	iterable	$iterable,
		int	$max = `null`
	)

Voir également: ProgressBar::iterate()

Références SymfonyStyle\createProgressBar(), et SymfonyStyle\newLine().

◆ progressStart()

progressStart ( int $max = 0 )

{Starts the progress output.}

Implémente StyleInterface.

Références SymfonyStyle\createProgressBar().

◆ section()

section ( string $message )

{Formats a section title.}

Implémente StyleInterface.

Références SymfonyStyle\autoPrependBlock(), OutputFormatter\escapeTrailingBackslash(), OutputStyle\getFormatter(), SymfonyStyle\newLine(), Helper\removeDecoration(), Helper\width(), et SymfonyStyle\writeln().

◆ success()

success ( $message )

{Formats a success result bar.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, et SymfonyStyle\block().

Référencé par LintCommand\displayTxt().

◆ table()

table	(	array	$headers,
		array	$rows
	)

{Formats a table.}

Implémente StyleInterface.

Références $rows, SymfonyStyle\createTable(), et SymfonyStyle\newLine().

◆ text()

text ( $message )

{Formats informational text.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, $messages, SymfonyStyle\autoPrependText(), et SymfonyStyle\writeln().

Référencé par LintCommand\displayTxt().

◆ title()

title ( string $message )

{Formats a command title.}

Implémente StyleInterface.

Références SymfonyStyle\autoPrependBlock(), OutputFormatter\escapeTrailingBackslash(), OutputStyle\getFormatter(), SymfonyStyle\newLine(), Helper\removeDecoration(), Helper\width(), et SymfonyStyle\writeln().

◆ warning()

warning ( $message )

{Formats an warning result bar.

Paramètres

string | array $message

}

Implémente StyleInterface.

Références $message, et SymfonyStyle\block().

Référencé par LintCommand\displayTxt().

◆ write()

write	(		$messages,
		bool	$newline = `false`,
		int	$type = `self::OUTPUT_NORMAL`
	)

{Writes a message to the output.

Paramètres

string \| iterable	$messages	The message as an iterable of strings or a single string
bool	$newline	Whether to add a newline
int	$options	A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL \| self::VERBOSITY_NORMAL

}

Implémente OutputInterface.

Références $message, $messages, $type, et SymfonyStyle\writeBuffer().

◆ writeBuffer()

writeBuffer	(	string	$message,
		bool	$newLine,
		int	$type
	)

private

Références $message, et $type.

Référencé par SymfonyStyle\write(), et SymfonyStyle\writeln().

◆ writeln()

writeln	(		$messages,
		int	$type = `self::OUTPUT_NORMAL`
	)

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

Paramètres

string \| iterable	$messages	The message as an iterable of strings or a single string
int	$options	A bitmask of options (one of the OUTPUT or VERBOSITY constants), 0 is considered the same as self::OUTPUT_NORMAL \| self::VERBOSITY_NORMAL

}

Implémente OutputInterface.

Références $message, $messages, $type, et SymfonyStyle\writeBuffer().

Référencé par SymfonyStyle\block(), LintCommand\displayJson(), SymfonyStyle\listing(), SymfonyStyle\section(), SymfonyStyle\text(), et SymfonyStyle\title().

Documentation des champs

◆ $bufferedOutput

$bufferedOutput

private

◆ $input

$input

private

Référencé par SymfonyStyle\__construct(), et SymfonyStyle\getErrorStyle().

◆ $lineLength

$lineLength

private

◆ $output

$output

private

Référencé par SymfonyStyle\__construct(), et SymfonyStyle\createTable().

◆ $progressBar

$progressBar

private

Référencé par SymfonyStyle\createProgressBar(), et SymfonyStyle\getProgressBar().

◆ $questionHelper

$questionHelper

private

◆ MAX_LINE_LENGTH

const MAX_LINE_LENGTH = 120

La documentation de cette classe a été générée à partir du fichier suivant :

SymfonyStyle.php

Fonctions membres publiques

Champs de données

Fonctions membres privées

Attributs privés

Membres hérités additionnels

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ ask()

◆ askHidden()

◆ askQuestion()

◆ autoPrependBlock()

◆ autoPrependText()

◆ block()

◆ caution()

◆ choice()

◆ comment()

◆ confirm()

◆ createBlock()

◆ createProgressBar()

◆ createTable()

◆ definitionList()

◆ error()

◆ getErrorStyle()

◆ getProgressBar()

◆ horizontalTable()

◆ info()

◆ listing()

◆ newLine()

◆ note()

◆ progressAdvance()

◆ progressFinish()

◆ progressIterate()

◆ progressStart()

◆ section()

◆ success()

◆ table()

◆ text()

◆ title()

◆ warning()

◆ write()

◆ writeBuffer()

◆ writeln()

Documentation des champs

◆ $bufferedOutput

◆ $input

◆ $lineLength

◆ $output

◆ $progressBar

◆ $questionHelper

◆ MAX_LINE_LENGTH