class OutputFormatter implements WrappableOutputFormatterInterface

Formatter class for console output.

Methods

static string
escape(string $text)

Escapes "<" special char in given text.

static string
escapeTrailingBackslash(string $text)

Escapes trailing "\" in given text.

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

Initializes console output formatter.

setDecorated(bool $decorated)

Sets the decorated flag.

bool
isDecorated()

Gets the decorated flag.

setStyle(string $name, OutputFormatterStyleInterface $style)

Sets a new style.

bool
hasStyle(string $name)

Checks if output formatter has style with specified name.

getStyle(string $name)

Gets style options from style with specified name.

string
format(string $message)

Formats a message according to the given styles.

formatAndWrap(string $message, int $width)

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

Details

at line 35
static string escape(string $text)

Escapes "<" special char in given text.

Parameters

string $text Text to escape

Return Value

string Escaped text

at line 51
static string escapeTrailingBackslash(string $text)

Escapes trailing "\" in given text.

Parameters

string $text Text to escape

Return Value

string Escaped text

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

Initializes console output formatter.

Parameters

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

at line 88
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages or not

at line 96
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

at line 104
setStyle(string $name, OutputFormatterStyleInterface $style)

Sets a new style.

Parameters

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

at line 112
bool hasStyle(string $name)

Checks if output formatter has style with specified name.

Parameters

string $name

Return Value

bool

at line 120
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

at line 132
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

at line 140
formatAndWrap(string $message, int $width)

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

Parameters

string $message
int $width

at line 190
OutputFormatterStyleStack getStyleStack()