Référence de l'interface OutputInterface

Graphe d'héritage de OutputInterface:

Fonctions membres publiques
	write ($messages, bool $newline=false, int $options=0)
	writeln ($messages, int $options=0)
	setVerbosity (int $level)
	getVerbosity ()
	isQuiet ()
	isVerbose ()
	isVeryVerbose ()
	isDebug ()
	setDecorated (bool $decorated)
	isDecorated ()
	setFormatter (OutputFormatterInterface $formatter)
	getFormatter ()

Champs de données
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

OutputInterface is the interface implemented by all Output classes.

Auteur

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Documentation des fonctions membres

getFormatter()

getFormatter

(

)

Returns current output formatter instance.

Renvoie

OutputFormatterInterface

Implémenté dans OutputStyle, Output, et NullOutput.

getVerbosity()

getVerbosity

(

)

Gets the current verbosity of the output.

Renvoie

int

Implémenté dans Output, NullOutput, et OutputStyle.

isDebug()

isDebug

(

)

Returns whether verbosity is debug (-vvv).

Renvoie

bool

Implémenté dans OutputStyle, Output, et NullOutput.

isDecorated()

isDecorated

(

)

Gets the decorated flag.

Renvoie

bool

Implémenté dans OutputStyle, Output, et NullOutput.

isQuiet()

isQuiet

(

)

Returns whether verbosity is quiet (-q).

Renvoie

bool

Implémenté dans OutputStyle, Output, et NullOutput.

isVerbose()

isVerbose

(

)

Returns whether verbosity is verbose (-v).

Renvoie

bool

Implémenté dans OutputStyle, Output, et NullOutput.

isVeryVerbose()

isVeryVerbose

(

)

Returns whether verbosity is very verbose (-vv).

Renvoie

bool

Implémenté dans OutputStyle, Output, et NullOutput.

setDecorated()

setDecorated

(

bool

$decorated

)

Sets the decorated flag.

Implémenté dans OutputStyle, ConsoleOutput, Output, et NullOutput.

setFormatter()

setFormatter

(

OutputFormatterInterface

$formatter

)

Implémenté dans OutputStyle, ConsoleOutput, Output, et NullOutput.

setVerbosity()

setVerbosity

(

int

$level

)

Sets the verbosity of the output.

Implémenté dans ConsoleOutput, Output, NullOutput, et OutputStyle.

write()

write	(		$messages,
		bool	$newline = false,
		int	$options = 0
	)

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émenté dans SymfonyStyle, Output, NullOutput, et OutputStyle.

writeln()

writeln	(		$messages,
		int	$options = 0
	)

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émenté dans SymfonyStyle, Output, NullOutput, et OutputStyle.

Référencé par Application\renderThrowable().

Documentation des champs

OUTPUT_NORMAL

const OUTPUT_NORMAL = 1

Référencé par Descriptor\write(), et Output\write().

OUTPUT_PLAIN

const OUTPUT_PLAIN = 4

Référencé par Output\write().

OUTPUT_RAW

const OUTPUT_RAW = 2

Référencé par Descriptor\write(), et Output\write().

VERBOSITY_DEBUG

const VERBOSITY_DEBUG = 256

Référencé par Application\configureIO(), ProgressIndicator\determineBestFormat(), ProgressBar\determineBestFormat(), et RemoveOldFilesCommand\doExecute().

VERBOSITY_NORMAL

const VERBOSITY_NORMAL = 32

Référencé par Symfony\Component\Console\Tester\initOutput().

VERBOSITY_QUIET

const VERBOSITY_QUIET = 16

Référencé par Application\configureIO(), ProgressIndicator\display(), ProgressBar\display(), Application\doRenderThrowable(), et Application\renderThrowable().

VERBOSITY_VERBOSE

const VERBOSITY_VERBOSE = 64

Référencé par Application\configureIO(), ProgressIndicator\determineBestFormat(), ProgressBar\determineBestFormat(), et RemoveOldFilesCommand\doExecute().

VERBOSITY_VERY_VERBOSE

const VERBOSITY_VERY_VERBOSE = 128

Référencé par Application\configureIO(), ProgressIndicator\determineBestFormat(), ProgressBar\determineBestFormat(), RemoveOldFilesCommand\doExecute(), et Command\run().

---

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

• OutputInterface.php