1. class
  2. Symfony
  3. Component
  4. Console
  5. Formatter
  6. OutputFormatter

OutputFormatter

class OutputFormatter implements OutputFormatterInterface

Formatter class for console output.

Methods

static string
escape(string $text)

Escapes "<" special char in given text.

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

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.

OutputFormatterStyleInterface
getStyle(string $name)

Gets style options from style with specified name.

string
format(string $message)

Formats a message according to the given styles.

OutputFormatterStyleStack
getStyleStack()

No description

Details

at line line 34
static string escape(string $text)

Escapes "<" special char in given text.

Parameters

string $text Text to escape

Return Value

string Escaped text

at line line 45
__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

at line line 66
setDecorated(bool $decorated)

Sets the decorated flag.

Parameters

bool $decorated Whether to decorate the messages or not

at line line 76
bool isDecorated()

Gets the decorated flag.

Return Value

bool true if the output will decorate messages, false otherwise

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

Sets a new style.

Parameters

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

at line line 99
bool hasStyle(string $name)

Checks if output formatter has style with specified name.

Parameters

string $name

Return Value

bool

at line line 113
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 line 129
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 line 175
OutputFormatterStyleStack getStyleStack()

Return Value

OutputFormatterStyleStack