interface OutputFormatterInterface

Formatter interface for console output.

Methods

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.

Details

at line line 26
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages or not

at line line 33
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

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

Sets a new style.

Parameters

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

at line line 50
bool hasStyle(string $name)

Checks if output formatter has style with specified name.

Parameters

string $name

Return Value

bool

at line line 59
OutputFormatterStyleInterface getStyle(string $name)

Gets style options from style with specified name.

Parameters

string $name

Return Value

OutputFormatterStyleInterface

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