Référence de la classe ConsoleOutput

Graphe d'héritage de ConsoleOutput:

Fonctions membres publiques
	__construct (int $verbosity=self::VERBOSITY_NORMAL, bool $decorated=null, OutputFormatterInterface $formatter=null)
	section ()
	setDecorated (bool $decorated)
	setFormatter (OutputFormatterInterface $formatter)
	setVerbosity (int $level)
	getErrorOutput ()
	setErrorOutput (OutputInterface $error)
Fonctions membres publiques hérités de StreamOutput
	__construct ($stream, int $verbosity=self::VERBOSITY_NORMAL, bool $decorated=null, OutputFormatterInterface $formatter=null)
	getStream ()
Fonctions membres publiques hérités de Output
	__construct (?int $verbosity=self::VERBOSITY_NORMAL, bool $decorated=false, OutputFormatterInterface $formatter=null)
	setFormatter (OutputFormatterInterface $formatter)
	getFormatter ()
	setDecorated (bool $decorated)
	isDecorated ()
	setVerbosity (int $level)
	getVerbosity ()
	isQuiet ()
	isVerbose ()
	isVeryVerbose ()
	isDebug ()
	writeln ($messages, int $options=self::OUTPUT_NORMAL)
	write ($messages, bool $newline=false, int $options=self::OUTPUT_NORMAL)

Fonctions membres protégées
	hasStdoutSupport ()
	hasStderrSupport ()
Fonctions membres protégées hérités de StreamOutput
	doWrite (string $message, bool $newline)
	hasColorSupport ()
Fonctions membres protégées hérités de Output
	doWrite (string $message, bool $newline)

Fonctions membres privées
	isRunningOS400 ()
	openOutputStream ()
	openErrorStream ()

Attributs privés
	$stderr
	$consoleSectionOutputs = []

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

ConsoleOutput is the default class for all CLI output. It uses STDOUT and STDERR.

This class is a convenient wrapper around StreamOutput for both STDOUT and STDERR.

$output = new ConsoleOutput();

This is equivalent to:

$output = new StreamOutput(fopen('php://stdout', 'w'));
$stdErr = new StreamOutput(fopen('php://stderr', 'w'));

Auteur

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

Documentation des constructeurs et destructeur

__construct()

__construct	(	int	$verbosity = self::VERBOSITY_NORMAL,
		bool	$decorated = null,
		OutputFormatterInterface	$formatter = null
	)

Paramètres

int	$verbosity	The verbosity level (one of the VERBOSITY constants in OutputInterface)
bool | null	$decorated	Whether to decorate messages (null for auto-guessing)
OutputFormatterInterface | null	$formatter	Output formatter instance (null to use default OutputFormatter)

Références Output\$formatter, Output\$verbosity, Symfony\Contracts\Service\__construct(), Output\getFormatter(), Output\isDecorated(), null, ConsoleOutput\openErrorStream(), ConsoleOutput\openOutputStream(), et ConsoleOutput\setDecorated().

Documentation des fonctions membres

getErrorOutput()

getErrorOutput

(

)

{Gets the OutputInterface for errors.

Renvoie

OutputInterface

}

Implémente ConsoleOutputInterface.

Références ConsoleOutput\$stderr.

hasStderrSupport()

hasStderrSupport ( )

protected

Returns true if current environment supports writing console output to STDERR.

Renvoie

bool

Références ConsoleOutput\isRunningOS400().

Référencé par ConsoleOutput\openErrorStream().

hasStdoutSupport()

hasStdoutSupport ( )

protected

Returns true if current environment supports writing console output to STDOUT.

Renvoie

bool

Références ConsoleOutput\isRunningOS400().

Référencé par ConsoleOutput\openOutputStream().

isRunningOS400()

isRunningOS400 ( )

private

Checks if current executing environment is IBM iSeries (OS400), which doesn't properly convert character-encodings between ASCII to EBCDIC.

Référencé par ConsoleOutput\hasStderrSupport(), et ConsoleOutput\hasStdoutSupport().

openErrorStream()

openErrorStream ( )

private

Renvoie

resource

Références ConsoleOutput\hasStderrSupport().

Référencé par ConsoleOutput\__construct().

openOutputStream()

openOutputStream ( )

private

Renvoie

resource

Références ConsoleOutput\hasStdoutSupport().

Référencé par ConsoleOutput\__construct().

section()

section

(

)

Creates a new output section.

Implémente ConsoleOutputInterface.

Références Output\getFormatter(), StreamOutput\getStream(), Output\getVerbosity(), et Output\isDecorated().

setDecorated()

setDecorated

(

bool

$decorated

)

{Sets the decorated flag.}

Implémente OutputInterface.

Référencé par ConsoleOutput\__construct().

setErrorOutput()

setErrorOutput

(

OutputInterface

$error

)

{}

Implémente ConsoleOutputInterface.

setFormatter()

setFormatter

(

OutputFormatterInterface

$formatter

)

{}

Implémente OutputInterface.

Références Output\$formatter.

setVerbosity()

setVerbosity

(

int

$level

)

{Sets the verbosity of the output.}

Implémente OutputInterface.

Documentation des champs

$consoleSectionOutputs

$consoleSectionOutputs = []

private

$stderr

$stderr

private

Référencé par ConsoleOutput\getErrorOutput().

---

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

• ConsoleOutput.php