OutputFormatterStyle

class OutputFormatterStyle implements OutputFormatterStyleInterface

Formatter style class for defining styles.

Methods

	__construct(string\|null $foreground = null, string\|null $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

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

Initializes output formatter style.

Parameters

string\|null	$foreground	The style foreground color name
string\|null	$background	The style background color name
array	$options	The style options

setForeground(string $color = null)

Sets style foreground color.

Parameters

string

$color

The color name

Exceptions

InvalidArgumentException

When the color name isn't defined

setBackground(string $color = null)

Sets style background color.

Parameters

string

$color

The color name

Exceptions

InvalidArgumentException

When the color name isn't defined

setOption(string $option)

Sets some specific style option.

Parameters

string

$option

The option name

Exceptions

InvalidArgumentException

When the option name isn't defined

unsetOption(string $option)

Unsets some specific style option.

Parameters

string

$option

The option name

Exceptions

InvalidArgumentException

When the option name isn't defined

setOptions(array $options)

Sets multiple style options at once.

Parameters

array

$options

string apply(string $text)

Applies the style to a given text.

Parameters

string

$text

The text to style

Return Value

string

Links:

http://api.symfony.com/master/Symfony/Component/Console/Formatter/OutputFormatterStyle.html

doc_Symfony

2025-01-10 15:47:30

Comments