Class

Symfony\Component\Console\Formatter\OutputFormatterStyle

class OutputFormatterStyle implements OutputFormatterStyleInterface

Formatter style class for defining styles.

Methods

__construct(string $foreground = null, string $background = null, array $options = array())

Initializes output formatter style.

setForeground(string $color = null)

Sets style foreground color.

setBackground(string $color = null)

Sets style background color.

setOption(string $option)

Sets some specific style option.

unsetOption(string $option)

Unsets some specific style option.

setOptions(array $options)

Sets multiple style options at once.

string apply(string $text)

Applies the style to a given text.

Details

at line 64
public __construct(string $foreground = null, string $background = null, array $options = array())

Initializes output formatter style.

Parameters

string $foreground The style foreground color name
string $background The style background color name
array $options The style options

at line 86
public setForeground(string $color = null)

Sets style foreground color.

Parameters

string $color The color name

Exceptions

InvalidArgumentException When the color name isn't defined

at line 114
public setBackground(string $color = null)

Sets style background color.

Parameters

string $color The color name

Exceptions

InvalidArgumentException When the color name isn't defined

at line 142
public setOption(string $option)

Sets some specific style option.

Parameters

string $option The option name

Exceptions

InvalidArgumentException When the option name isn't defined

at line 165
public unsetOption(string $option)

Unsets some specific style option.

Parameters

string $option The option name

Exceptions

InvalidArgumentException When the option name isn't defined

at line 186
public setOptions(array $options)

Sets multiple style options at once.

Parameters

array $options

at line 202
public string apply(string $text)

Applies the style to a given text.

Parameters

string $text The text to style

Return Value

string