Référence de la classe OutputFormatter

Graphe d'héritage de OutputFormatter:

Fonctions membres publiques
	__clone ()
	__construct (bool $decorated=false, array $styles=[])
	setDecorated (bool $decorated)
	isDecorated ()
	setStyle (string $name, OutputFormatterStyleInterface $style)
	hasStyle (string $name)
	getStyle (string $name)
	format (?string $message)
	formatAndWrap (?string $message, int $width)
	getStyleStack ()

Fonctions membres publiques statiques
static	escape (string $text)
static	escapeTrailingBackslash (string $text)

Fonctions membres privées
	createStyleFromString (string $string)
	applyCurrentStyle (string $text, string $current, int $width, int &$currentLineLength)

Attributs privés
	$decorated
	$styles = []
	$styleStack

Description détaillée

Formatter class for console output.

Auteur

Konstantin Kudryashov ever..nosp@m.zet@.nosp@m.gmail.nosp@m..com

Roland Franssen frans.nosp@m.sen..nosp@m.rolan.nosp@m.d@gm.nosp@m.ail.c.nosp@m.om

Documentation des constructeurs et destructeur

__construct()

__construct	(	bool	$decorated = false,
		array	$styles = []
	)

Initializes console output formatter.

Paramètres

OutputFormatterStyleInterface[]

$styles Array of "name => FormatterStyle" instances

Références OutputFormatter\$decorated, $name, $style, OutputFormatter\$styles, et OutputFormatter\setStyle().

Documentation des fonctions membres

__clone()

__clone

(

)

Références $key, OutputFormatter\$styleStack, et $value.

applyCurrentStyle()

applyCurrentStyle ( string  $text, string  $current, int  $width, int &  $currentLineLength  )

private

Applies current style from stack to text, if must be applied.

Références $i, $prefix, $text, $width, et OutputFormatter\isDecorated().

Référencé par OutputFormatter\formatAndWrap().

createStyleFromString()

createStyleFromString ( string  $string )

private

Tries to create new style instance from string.

Références $option, $options, $style, $url, elseif, et null.

Référencé par OutputFormatter\formatAndWrap().

escape()

static escape ( string  $text )

static

Escapes "<" and ">" special chars in given text.

Renvoie

string

Références $text.

Référencé par SymfonyStyle\createBlock(), TextDescriptor\describeCommand(), Application\doRenderThrowable(), FormatterHelper\formatBlock(), TextDescriptor\formatDefaultValue(), Application\renderThrowable(), et SymfonyQuestionHelper\writePrompt().

escapeTrailingBackslash()

static escapeTrailingBackslash ( string  $text )

static

Escapes trailing "\" in given text.

Références $text.

Référencé par QuestionHelper\autocomplete(), SymfonyStyle\section(), SymfonyStyle\title(), et SymfonyQuestionHelper\writePrompt().

format()

format

(

?string

$message

)

{Formats a message according to the given styles.

Renvoie

string|null

}

Implémente OutputFormatterInterface.

Références OutputFormatter\formatAndWrap().

formatAndWrap()

formatAndWrap	(	?string	$message,
		int	$width
	)

{Formats a message according to the given styles, wrapping at $width (0 means no wrapping).}

Implémente WrappableOutputFormatterInterface.

Références $i, $message, Joomla\Database\Query\$offset, $output, $style, $text, $width, OutputFormatter\applyCurrentStyle(), OutputFormatter\createStyleFromString(), elseif, et null.

Référencé par OutputFormatter\format().

getStyle()

getStyle

(

string

$name

)

{Gets style options from style with specified name.

Renvoie

OutputFormatterStyleInterface

Exceptions

}

Implémente OutputFormatterInterface.

Références $name, et OutputFormatter\hasStyle().

getStyleStack()

getStyleStack

(

)

Renvoie

OutputFormatterStyleStack

Références OutputFormatter\$styleStack.

hasStyle()

hasStyle

(

string

$name

)

{Checks if output formatter has style with specified name.

Renvoie

bool

}

Implémente OutputFormatterInterface.

Références $name.

Référencé par OutputFormatter\getStyle().

isDecorated()

isDecorated

(

)

{Whether the output will decorate messages.

Renvoie

bool

}

Implémente OutputFormatterInterface.

Références OutputFormatter\$decorated.

Référencé par OutputFormatter\applyCurrentStyle().

setDecorated()

setDecorated

(

bool

$decorated

)

{Sets the decorated flag.}

Implémente OutputFormatterInterface.

Références OutputFormatter\$decorated.

setStyle()

setStyle	(	string	$name,
		OutputFormatterStyleInterface	$style
	)

{Sets a new style.}

Implémente OutputFormatterInterface.

Références $name, et $style.

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

Documentation des champs

$decorated

$decorated

private

Référencé par OutputFormatter\__construct(), OutputFormatter\isDecorated(), et OutputFormatter\setDecorated().

$styles

$styles = []

private

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

$styleStack

$styleStack

private

Référencé par OutputFormatter\__clone(), et OutputFormatter\getStyleStack().

---

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

• OutputFormatter.php