DefaultLogger

Implements \StreamRequiredBuildLogger

Writes a build event to the console.

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

author

Andreas Aderhold andi@binarycloud.com

copyright

2001,2002 THYRELL. All rights reserved

version

$Id: 9f48981bbf3c63ff866a830618c24cafd61cf050 $

see
package

phing.listener

Methods

Construct a new default logger.

__construct() 

Set the msgOutputLevel this logger is to respond to.

setMessageOutputLevel(int $level) 

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.

see \BuildLogger#setMessageOutputLevel()

Arguments

$level

int

The logging level for the logger.

Sets the output stream.

setOutputStream(\OutputStream $output) 
see \BuildLogger#setOutputStream()

Arguments

$output

\OutputStream

Sets the error stream.

setErrorStream(\OutputStream $err) 
see \BuildLogger#setErrorStream()

Arguments

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

buildStarted(\BuildEvent $event) 

@param object The BuildEvent

access

public

Arguments

$event

\BuildEvent

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

buildFinished(\BuildEvent $event) 

@param object The BuildEvent

see \BuildEvent::getException()

Arguments

$event

\BuildEvent

Get the message to return when a build failed.

getBuildFailedMessage() : string

Response

string

The classic "BUILD FAILED"

Get the message to return when a build succeeded.

getBuildSuccessfulMessage() : string

Response

string

The classic "BUILD FINISHED"

Prints the current target name

targetStarted(\BuildEvent $event) 

@param object The BuildEvent

access

public @see BuildEvent::getTarget()

Arguments

$event

\BuildEvent

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

targetFinished(\BuildEvent $event) 

@param object The BuildEvent

see \BuildEvent::getException()

Arguments

$event

\BuildEvent

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

taskStarted(\BuildEvent $event) 

@param object The BuildEvent

access

public @see BuildEvent::getTask()

Arguments

$event

\BuildEvent

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

taskFinished(\BuildEvent $event) 

@param object The BuildEvent

access

public @see BuildEvent::getException()

Arguments

$event

\BuildEvent

Print a message to the stdout.

messageLogged(\BuildEvent $event) 

@param object The BuildEvent

access

public @see BuildEvent::getMessage()

Arguments

$event

\BuildEvent

Formats a time micro integer to human readable format.

formatTime($micros) 
static

@param integer The time stamp

access

private

Arguments

$micros

Prints a message to console.

printMessage(string $message, resource $stream, int $priority) : void

Arguments

$message

string

The message to print. Should not be null.

$stream

resource

The stream to use for message printing.

$priority

int

The priority of the message. (Ignored in this implementation.)

Constants

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

LEFT_COLUMN_SIZE

@var int

Properties

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

msgOutputLevel : 

@var int

Time that the build started

startTime : 

@var int

Stream to use for standard output.

out : \OutputStream
var

Stream to use for standard output.

Type(s)

\OutputStream

Stream to use for error output.

err : \OutputStream
var

Stream to use for error output.

Type(s)

\OutputStream