listener/HtmlColorLogger.php

Show: inherited
Table of Contents

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:

Author
Anton Stöckl (Phing HTML Color Logger)  
Author
Hans Lellelid (Phing Ansi Color Logger)  
Author
Magesh Umasankar (Ant)  
Package
phing.listener  
Version
$Id: 4b57f4d435b61b6501688394f1ff8534d4b7e93f $  

\HtmlColorLogger

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 < \StreamRequiredBuildLogger < \BuildLogger < \BuildListener
Author
Anton Stöckl (Phing HTML Color Logger)  
Author
Hans Lellelid (Phing Ansi Color Logger)  
Author
Magesh Umasankar (Ant)  
Copyright
2001,2002 THYRELL. All rights reserved  
Version
$Id: 4b57f4d435b61b6501688394f1ff8534d4b7e93f $  

Constants

Constant  CLASS_ERR = 'phing_err'
Constant  CLASS_VERBOSE = 'phing_verbose'
Constant  CLASS_DEBUG = 'phing_debug'
Constant  CLASS_WARN = 'phing_warn'
Constant  CLASS_INFO = 'phing_info'
Constant  PREFIX = '<span class="'
Constant  SUFFIX = '">'
Constant  END_COLOR = '</span>'
Constant  LEFT_COLUMN_SIZE = 12
inherited

Size of the left column in output. The default char width is 12.

Inherited from: \DefaultLogger::LEFT_COLUMN_SIZE

@var int

Inherited_from
\DefaultLogger::LEFT_COLUMN_SIZE  

Properties

Propertyprivate  $colorsSet= 'false'
Default valuefalseDetails
Type
n/a
Propertyprivate  $debugColor= ''
Details
Type
n/a
Propertyprotected\OutputStream  $err= ''
inherited

Stream to use for error output.Inherited from: \DefaultLogger::$$err
Details
Type
\OutputStream
Inherited_from
\DefaultLogger::$$err  
Propertyprivate  $errColor= ''
Details
Type
n/a
Propertyprivate  $infoColor= ''
Details
Type
n/a
Propertyprotected  $msgOutputLevel= 'Project::MSG_ERR'
inherited

The message output level that should be used. The default is <code>Project::MSG_VERBOSE</code>.

Inherited from: \DefaultLogger::$$msgOutputLevel

@var int

Default valueProject::MSG_ERRDetails
Type
n/a
Inherited_from
\DefaultLogger::$$msgOutputLevel  
Propertyprotected\OutputStream  $out= ''
inherited

Stream to use for standard output.Inherited from: \DefaultLogger::$$out
Details
Type
\OutputStream
Inherited_from
\DefaultLogger::$$out  
Propertyprotected  $startTime= ''
inherited

Time that the build started

Inherited from: \DefaultLogger::$$startTime

@var int

Details
Type
n/a
Inherited_from
\DefaultLogger::$$startTime  
Propertyprivate  $verboseColor= ''
Details
Type
n/a
Propertyprivate  $warnColor= ''
Details
Type
n/a

Methods

methodpublic__construct( ) : void

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

methodpublicbuildFinished(  $event ) : void
inherited

Prints whether the build succeeded or failed, and any errors that occured during the build. Also outputs the total build-time.

Inherited from: \DefaultLogger::buildFinished()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
See
\BuildEvent::getException()  
methodpublicbuildStarted(  $event ) : void
inherited

Sets the start-time when the build started. Used for calculating the build-time.

Inherited from: \DefaultLogger::buildStarted()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
Access
public  
methodpublicformatTime(  $micros ) : void
staticinherited

Formats a time micro integer to human readable format.

Inherited from: \DefaultLogger::formatTime()

@param integer The time stamp

Parameters
Name Type Description
$micros
Details
Access
private  
methodprotectedgetBuildFailedMessage( ) : string
inherited

Get the message to return when a build failed.

Inherited from: \DefaultLogger::getBuildFailedMessage()
Returns
Type Description
string The classic "BUILD FAILED"
methodprotectedgetBuildSuccessfulMessage( ) : string
inherited

Get the message to return when a build succeeded.

Inherited from: \DefaultLogger::getBuildSuccessfulMessage()
Returns
Type Description
string The classic "BUILD FINISHED"
methodpublicmessageLogged(  $event ) : void
inherited

Print a message to the stdout.

Inherited from: \DefaultLogger::messageLogged()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
Access
public  
See
\BuildEvent::getMessage()  
methodprotectedprintMessage( string $message, \OutputStream $stream, int $priority ) : void
final

Prints a message to console.

Parameters
Name Type Description
$message string
$stream \OutputStream
$priority int
Details
See
\DefaultLogger#printMessage  
methodprivatesetColors( ) : void
final

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

methodpublicsetErrorStream( \OutputStream $err ) : void
inherited

Sets the error stream.

Inherited from: \DefaultLogger::setErrorStream()
Parameters
Name Type Description
$err \OutputStream
Details
See
\BuildLogger#setErrorStream()  
methodpublicsetMessageOutputLevel( int $level ) : void
inherited

Set the msgOutputLevel this logger is to respond to.

Inherited from: \DefaultLogger::setMessageOutputLevel()

Only messages with a message level lower than or equal to the given level are output to the log.

<

p> Constants for the message levels are in Project.php. The order of the levels, from least to most verbose, is:

  • Project::MSG_ERR
  • Project::MSG_WARN
  • Project::MSG_INFO
  • Project::MSG_VERBOSE
  • Project::MSG_DEBUG

The default message level for DefaultLogger is Project::MSG_ERR.

Parameters
Name Type Description
$level int

The logging level for the logger.

Details
See
\BuildLogger#setMessageOutputLevel()  
methodpublicsetOutputStream( \OutputStream $output ) : void
inherited

Sets the output stream.

Inherited from: \DefaultLogger::setOutputStream()
Parameters
Name Type Description
$output \OutputStream
Details
See
\BuildLogger#setOutputStream()  
methodpublictargetFinished(  $event ) : void
inherited

Fired when a target has finished. We don't need specific action on this event. So the methods are empty.

Inherited from: \DefaultLogger::targetFinished()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
See
\BuildEvent::getException()  
methodpublictargetStarted(  $event ) : void
inherited

Prints the current target name

Inherited from: \DefaultLogger::targetStarted()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
Access
public  
See
\BuildEvent::getTarget()  
methodpublictaskFinished(  $event ) : void
inherited

Fired when a task has finished. We don't need specific action on this event. So the methods are empty.

Inherited from: \DefaultLogger::taskFinished()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
Access
public  
See
\BuildEvent::getException()  
methodpublictaskStarted(  $event ) : void
inherited

Fired when a task is started. We don't need specific action on this event. So the methods are empty.

Inherited from: \DefaultLogger::taskStarted()

@param object The BuildEvent

Parameters
Name Type Description
$event
Details
Access
public  
See
\BuildEvent::getTask()  
Documentation was generated by DocBlox 0.18.1.