MailLogger

Extends \DefaultLogger

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.

author

Michiel Rook mrook@php.net

package

phing.listener

version

$Id: 88d960e37146f978be47dfb583cef5cd80f55c1d $

Methods

Construct a new default logger.

__construct() 
inherited

Sends the mail

buildFinished(\BuildEvent $event) 
see \DefaultLogger#buildFinished

Arguments

$event

\BuildEvent

Formats a time micro integer to human readable format.

formatTime( $micros) : string
inherited static

Arguments

$micros

Response

string

Get the message to return when a build failed.

getBuildFailedMessage() : string
inherited

Response

string

The classic "BUILD FAILED"

Get the message to return when a build succeeded.

getBuildSuccessfulMessage() : string
inherited

Response

string

The classic "BUILD FINISHED"

Prints a message to console.

printMessage(string $message, \OutputStream|resource $stream, integer $priority) : void
inherited
throws

Arguments

$message

string

The message to print.

                       Should not be <code>null</code>.

$stream

\OutputStream|resource

The stream to use for message printing.

$priority

integer

The priority of the message.

                       (Ignored in this implementation.)

Sets the error stream.

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

Arguments

Set the msgOutputLevel this logger is to respond to.

setMessageOutputLevel(integer $level) 
inherited

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

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

integer

The logging level for the logger.

Sets the output stream.

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

Arguments

$output

\OutputStream

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

taskFinished(\BuildEvent $event) 
inherited
see \BuildEvent::getException()

Arguments

$event

\BuildEvent

The BuildEvent

Constants

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

LEFT_COLUMN_SIZE
inherited
var

Properties

_mailMessage

_mailMessage : 

Type(s)

_from

_from : 

Type(s)

_subject

_subject : 

Type(s)

_tolist

_tolist : 

Type(s)

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

msgOutputLevel : integer
inherited
var

Type(s)

integer

Time that the build started

startTime : integer
inherited
var

Type(s)

integer

Stream to use for standard output.

out : \OutputStream
inherited
var

Stream to use for standard output.

Type(s)

\OutputStream

Stream to use for error output.

err : \OutputStream
inherited
var

Stream to use for error output.

Type(s)

\OutputStream