OutputFormatter

static string escape(string $text)

Escapes "<" special char in given text.

Parameters

string

$text

Text to escape

Return Value

string

Escaped text

static string escapeTrailingBackslash(string $text)

Escapes trailing "\" in given text.

Parameters

string

$text

Text to escape

Return Value

string

Escaped text

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

Initializes console output formatter.

Parameters

bool	$decorated	Whether this formatter should actually decorate strings
array	$styles	Array of "name => FormatterStyle" instances

setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool

$decorated

Whether to decorate the messages or not

bool isDecorated()

Gets the decorated flag.

Return Value

bool	true if the output will decorate messages, false otherwise

setStyle(string $name, OutputFormatterStyleInterface $style)

Sets a new style.

Parameters

string	$name	The style name
OutputFormatterStyleInterface	$style	The style instance

bool hasStyle(string $name)

Checks if output formatter has style with specified name.

Parameters

string

$name

Return Value

bool

OutputFormatterStyleInterface getStyle(string $name)

Gets style options from style with specified name.

Parameters

string

$name

Return Value

OutputFormatterStyleInterface

Exceptions

InvalidArgumentException

When style isn't defined

string format(string $message)

Formats a message according to the given styles.

Parameters

string

$message

The message to style

Return Value

string

The styled message

OutputFormatterStyleStack getStyleStack()

Return Value

OutputFormatterStyleStack