### Classes, interfaces and traits

# AnsiColorLogger¶

Uses ANSI Color Code Sequences to colorize messages sent to the console.

If used with the -logfile option, the output file will contain all the necessary escape codes to display the text in colorized mode when displayed in the console using applications like cat, more, etc. This is designed to work on terminals that support ANSI color codes. It works on XTerm, ETerm, Mindterm, etc. It also works on Win9x (with ANSI.SYS loaded.) NOTE: It doesn't work on WinNT's COMMAND.COM even with ANSI.SYS loaded. The default colors used for differentiating the message levels can be changed by editing the phing/listener/defaults.properties file. This file contains 5 key/value pairs: AnsiColorLogger.ERROR_COLOR=2;31 AnsiColorLogger.WARNING_COLOR=2;35 AnsiColorLogger.INFO_COLOR=2;36 AnsiColorLogger.VERBOSE_COLOR=2;32 AnsiColorLogger.DEBUG_COLOR=2;34 Another option is to pass a system variable named ant.logger.defaults, with value set to the path of the file that contains user defined Ansi Color Codes, to the <B>java</B> command using -D option. To change these colors use the following chart: <B>ANSI COLOR LOGGER CONFIGURATION</B> Format for AnsiColorLogger.*= Attribute;Foreground;Background Attribute is one of the following: 0 -> Reset All Attributes (return to normal mode) 1 -> Bright (Usually turns on BOLD) 2 -> Dim 3 -> Underline 5 -> link 7 -> Reverse 8 -> Hidden Foreground is one of the following: 30 -> Black 31 -> Red 32 -> Green 33 -> Yellow 34 -> Blue 35 -> Magenta 36 -> Cyan 37 -> White Background is one of the following: 40 -> Black 41 -> Red 42 -> Green 43 -> Yellow 44 -> Blue 45 -> Magenta 46 -> Cyan 47 -> White
« More »

# DefaultLogger¶

Writes a build event to the console.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# HtmlColorLogger¶

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 <span> 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:
« More »

# JsonLogger¶

Generates a file in the current directory with an JSON description of what happened during a build.

The default filename is "log.json", but this can be overridden with the property <code>JsonLogger.file</code>.
« More »

# MailLogger¶

Uses PEAR Mail package to send the build log to one or more recipients.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# NoBannerLogger¶

Extends DefaultLogger to strip out empty targets.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# PearLogListener¶

Writes build messages to PEAR Log.

By default it will log to file in current directory w/ name 'phing.log'. You can customize this behavior by setting properties: - pear.log.type - pear.log.name - pear.log.ident (note that this class changes ident to project name) - pear.log.conf (note that array values are currently unsupported in Phing property files) <code> phing -f build.xml -logger phing.listener.PearLogger -Dpear.log.type=file -Dpear.log.name=/path/to/log.log </code>
« More »

# ProfileLogger¶

This is a special logger that is designed to profile builds.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# SilentLogger¶

A logger which logs nothing but build failure and what task might output.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# TargetLogger¶

Extends AnsiColorLogger to display times for each target

If used with the -logfile option, the output file will contain all the necessary escape codes to display the text in colorized mode when displayed in the console using applications like cat, more, etc. This is designed to work on terminals that support ANSI color codes. It works on XTerm, ETerm, Mindterm, etc. It also works on Win9x (with ANSI.SYS loaded.) NOTE: It doesn't work on WinNT's COMMAND.COM even with ANSI.SYS loaded. The default colors used for differentiating the message levels can be changed by editing the phing/listener/defaults.properties file. This file contains 5 key/value pairs: AnsiColorLogger.ERROR_COLOR=2;31 AnsiColorLogger.WARNING_COLOR=2;35 AnsiColorLogger.INFO_COLOR=2;36 AnsiColorLogger.VERBOSE_COLOR=2;32 AnsiColorLogger.DEBUG_COLOR=2;34 Another option is to pass a system variable named ant.logger.defaults, with value set to the path of the file that contains user defined Ansi Color Codes, to the <B>java</B> command using -D option. To change these colors use the following chart: <B>ANSI COLOR LOGGER CONFIGURATION</B> Format for AnsiColorLogger.*= Attribute;Foreground;Background Attribute is one of the following: 0 -> Reset All Attributes (return to normal mode) 1 -> Bright (Usually turns on BOLD) 2 -> Dim 3 -> Underline 5 -> link 7 -> Reverse 8 -> Hidden Foreground is one of the following: 30 -> Black 31 -> Red 32 -> Green 33 -> Yellow 34 -> Blue 35 -> Magenta 36 -> Cyan 37 -> White Background is one of the following: 40 -> Black 41 -> Red 42 -> Green 43 -> Yellow 44 -> Blue 45 -> Magenta 46 -> Cyan 47 -> White
« More »

# TimestampedLogger¶

Like a normal logger, except with timed outputs.

Currently, it only writes which targets are being executed, and any messages that get logged.
« More »

# XmlLogger¶

Generates a file in the current directory with an XML description of what happened during a build.

The default filename is "log.xml", but this can be overridden with the property <code>XmlLogger.file</code>.
« More »