# listener/HtmlColorLogger.php

## \HtmlColorLogger
jump to top

Package: phing\listener

Uses CSS class that must be defined in the HTML page where the Phing output is displayed.

If used with the -logfile option, the output will contain the text wrapped in html elements with those css classes.

The default classes used for differentiating the message levels can be changed by editing the phing/listener/defaults.properties file.

This file can contain 5 key/value pairs: HtmlColorLogger.ERROR_CLASS=your_css_class_name HtmlColorLogger.WARNING_CLASS=your_css_class_name HtmlColorLogger.INFO_CLASS=your_css_class_name HtmlColorLogger.VERBOSE_CLASS=your_css_class_name HtmlColorLogger.DEBUG_CLASS=your_css_class_name

This stems from the Ansi Color Logger done by Hans Lellelid:

Parent(s)
  \DefaultLogger
Author
  Anton Stöckl (Phing HTML Color Logger)
Author
  Hans Lellelid (Phing Ansi Color Logger)
Author
  Magesh Umasankar (Ant)
Version
  $Revision: 1091 $

### Constants

`CLASS_ERR = 'phing_err'`

`CLASS_VERBOSE = 'phing_verbose'`

`CLASS_DEBUG = 'phing_debug'`

`CLASS_WARN = 'phing_warn'`

`CLASS_INFO = 'phing_info'`

`PREFIX = '<span class="'`

`SUFFIX = '">'`

`END_COLOR = '</span>'`

### Properties

`$colorsSet= 'false'`
Default value `false` Details

Type
  n/a

`$debugColor= ''`
Details

Type
  n/a

`$errColor= ''`
Details

Type
  n/a

`$infoColor= ''`
Details

Type
  n/a

`$verboseColor= ''`
Details

Type
  n/a

`$warnColor= ''`
Details

Type
  n/a

### Methods

`__construct( ) : void`

Construct new HtmlColorLogger Perform initializations that cannot be done in var declarations.

`buildFinished( ) : void`

`buildStarted( ) : void`

`formatTime( ) : void`
static

`getBuildFailedMessage( ) : void`

`getBuildSuccessfulMessage( ) : void`

`messageLogged( ) : void`

`printMessage( string $message, \OutputStream $stream, int $priority ) : void`
final

Parameters

Name | Type | Description
--- | --- | ---
$message | string |
$stream | \OutputStream |
$priority | int |

Details

See
  \DefaultLogger#printMessage

`setColors( ) : void`
final

Set the colors to use from a property file specified in the special phing property file "phing/listener/defaults.properties".

`setErrorStream( ) : void`

`setMessageOutputLevel( ) : void`

`setOutputStream( ) : void`

`targetFinished( ) : void`

`targetStarted( ) : void`

`taskFinished( ) : void`

`taskStarted( ) : void`

Documentation was generated by DocBlox 0.17.1.