Référence de la classe OutputStyle

Graphe d'héritage de OutputStyle:

Fonctions membres publiques
	__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 ()
Fonctions membres publiques hérités de StyleInterface
	title (string $message)
	section (string $message)
	listing (array $elements)
	text ($message)
	success ($message)
	error ($message)
	warning ($message)
	note ($message)
	caution ($message)
	table (array $headers, array $rows)
	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 ()

Fonctions membres protégées
	getErrorOutput ()

Attributs privés
	$output

Membres hérités additionnels
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

Description détaillée

Decorates output to add console style guide helpers.

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct

(

OutputInterface

$output

)

Références OutputStyle\$output.

Documentation des fonctions membres

createProgressBar()

createProgressBar

(

int

$max = 0

)

Renvoie

ProgressBar

getErrorOutput()

getErrorOutput ( )

protected

Références OutputStyle\$output.

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

getFormatter()

getFormatter

(

)

{Returns current output formatter instance.

Renvoie

OutputFormatterInterface

}

Implémente OutputInterface.

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

getVerbosity()

getVerbosity

(

)

{Gets the current verbosity of the output.

Renvoie

int

}

Implémente OutputInterface.

isDebug()

isDebug

(

)

{Returns whether verbosity is debug (-vvv).

Renvoie

bool

}

Implémente OutputInterface.

isDecorated()

isDecorated

(

)

{Gets the decorated flag.

Renvoie

bool

}

Implémente OutputInterface.

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

isQuiet()

isQuiet

(

)

{Returns whether verbosity is quiet (-q).

Renvoie

bool

}

Implémente OutputInterface.

isVerbose()

isVerbose

(

)

{Returns whether verbosity is verbose (-v).

Renvoie

bool

}

Implémente OutputInterface.

isVeryVerbose()

isVeryVerbose

(

)

{Returns whether verbosity is very verbose (-vv).

Renvoie

bool

}

Implémente OutputInterface.

newLine()

newLine

(

int

$count = 1

)

{Add newline(s).}

Implémente StyleInterface.

Références $count.

setDecorated()

setDecorated

(

bool

$decorated

)

{Sets the decorated flag.}

Implémente OutputInterface.

setFormatter()

setFormatter

(

OutputFormatterInterface

$formatter

)

{}

Implémente OutputInterface.

setVerbosity()

setVerbosity

(

int

$level

)

{Sets the verbosity of the output.}

Implémente OutputInterface.

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 $messages, et $type.

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 $messages, et $type.

Documentation des champs

$output

$output

private

Référencé par OutputStyle\__construct(), et OutputStyle\getErrorOutput().

---

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

• OutputStyle.php