ColorProcessor

Implements ProcessorInterface

Command line output processor supporting ANSI-colored output

deprecated
since

4.0.0

deprecated

4.3 will be removed in 6.0 Use the joomla/console package instead

package

Joomla CMS

Methods

__construct

Class constructor

__construct( noColors = null) : 
since

4.0.0

Arguments

noColors

boolDefines non-colored mode on construct

Response

mixed

addPredefinedStyles

Adds predefined color styles to the ColorProcessor object

addPredefinedStyles() : 
since

4.0.0

Response

$this

addStyle

Add a style.

addStyle( name, \Joomla\CMS\Application\CLI\ColorStyle style) : 
since

4.0.0

Arguments

name

stringThe style name.

style

ColorStyleThe color style.

Response

$this

process

Process a string.

process( string) : 
since

4.0.0

Arguments

string

stringThe string to process.

Response

string

replaceColors

Replace color tags in a string.

replaceColors( text,  tag,  match, \Joomla\CMS\Application\CLI\ColorStyle style) : 
since

4.0.0

Arguments

text

stringThe original text.

tag

stringThe matched tag.

match

stringThe match.

style

ColorStyleThe color style to apply.

Response

mixed

stripColors

Strip color tags from a string.

stripColors( string) : 
static
since

4.0.0

Arguments

string

stringThe string.

Response

string

Properties

noColors

Flag to remove color codes from the output

since

4.0.0

Type(s)

bool

tagFilter

Regex to match tags

since

4.0.0

Type(s)

string

stripFilter

Regex used for removing color codes

static
since

4.0.0

Type(s)

string

styles

Array of ColorStyle objects

since

4.0.0

Type(s)

array<string|int, ColorStyle>