listener/MailLogger.php
Uses PEAR Mail package to send the build log to one or more recipients.
- Author
- Michiel Rook
- Package
- phing.listener
- Version
- $Id$
\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.
- Parent(s)
- \DefaultLogger < \StreamRequiredBuildLogger < \BuildLogger < \BuildListener
- Author
- Michiel Rook
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id$
Constants

LEFT_COLUMN_SIZE
= 12
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


\OutputStream
$err= ''
- Type
- \OutputStream
- Inherited_from
- \DefaultLogger::$$err


$msgOutputLevel= 'Project::MSG_ERR'
The message output level that should be used. The default is <code>Project::MSG_VERBOSE</code>.
Inherited from: \DefaultLogger::$$msgOutputLevel@var int
Project::MSG_ERR
Details- Type
- n/a
- Inherited_from
- \DefaultLogger::$$msgOutputLevel


\OutputStream
$out= ''
- Type
- \OutputStream
- Inherited_from
- \DefaultLogger::$$out
Methods


buildFinished(
\BuildEvent $event
)
:
void
Sends the mail
@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event | \BuildEvent |
- See
- \DefaultLogger#buildFinished


buildStarted(
$event
)
:
void
Sets the start-time when the build started. Used for calculating the build-time.
Inherited from: \DefaultLogger::buildStarted()@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public


formatTime(
$micros
)
:
void
Formats a time micro integer to human readable format.
Inherited from: \DefaultLogger::formatTime()@param integer The time stamp
Name | Type | Description |
---|---|---|
$micros |
- Access
- private


getBuildFailedMessage(
)
:
string
Get the message to return when a build failed.
Inherited from: \DefaultLogger::getBuildFailedMessage()Type | Description |
---|---|
string | The classic "BUILD FAILED" |


getBuildSuccessfulMessage(
)
:
string
Get the message to return when a build succeeded.
Inherited from: \DefaultLogger::getBuildSuccessfulMessage()Type | Description |
---|---|
string | The classic "BUILD FINISHED" |


messageLogged(
$event
)
:
void
@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getMessage()


printMessage(
string $message, \OutputStream $stream, int $priority
)
:
void
Prints a message to console.
Name | Type | Description |
---|---|---|
$message | string | |
$stream | \OutputStream | |
$priority | int |
- See
- \DefaultLogger#printMessage


setErrorStream(
\OutputStream $err
)
:
void
Name | Type | Description |
---|---|---|
$err | \OutputStream |
- See
- \BuildLogger#setErrorStream()


setMessageOutputLevel(
int $level
)
:
void
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.
Name | Type | Description |
---|---|---|
$level | int | The logging level for the logger. |
- See
- \BuildLogger#setMessageOutputLevel()


setOutputStream(
\OutputStream $output
)
:
void
Name | Type | Description |
---|---|---|
$output | \OutputStream |
- See
- \BuildLogger#setOutputStream()


targetFinished(
$event
)
:
void
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
Name | Type | Description |
---|---|---|
$event |


targetStarted(
$event
)
:
void
@param object The BuildEvent
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getTarget()


taskFinished(
$event
)
:
void
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
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getException()


taskStarted(
$event
)
:
void
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
Name | Type | Description |
---|---|---|
$event |
- Access
- public
- See
- \BuildEvent::getTask()