OutputFormatterStyleInterface Interface Reference

Inheritance diagram for OutputFormatterStyleInterface:

Public Member Functions
	setForeground ($color=null)
	setBackground ($color=null)
	setOption ($option)
	unsetOption ($option)
	setOptions (array $options)
	apply ($text)

Detailed Description

Formatter style interface for defining styles.

Author

Konstantin Kudryashov ever..nosp@m.zet@.nosp@m.gmail.nosp@m..com

Definition at line 21 of file OutputFormatterStyleInterface.php.

Member Function Documentation

apply

(

$text

)

Applies the style to a given text.

Parameters

string

$text

The text to style

Returns

string

Implemented in OutputFormatterStyle.

setBackground

(

$color = null

)

Sets style background color.

Parameters

string

$color

The color name

Implemented in OutputFormatterStyle.

setForeground

(

$color = null

)

Sets style foreground color.

Parameters

string

$color

The color name

Implemented in OutputFormatterStyle.

setOption

(

$option

)

Sets some specific style option.

Parameters

string

$option

The option name

Implemented in OutputFormatterStyle.

setOptions

(

array

$options

)

Sets multiple style options at once.

Parameters

array

$options

Implemented in OutputFormatterStyle.

unsetOption

(

$option

)

Unsets some specific style option.

Parameters

string

$option

The option name

Implemented in OutputFormatterStyle.