listener/StreamRequiredBuildLogger.php
Interface for build loggers that require that out/err streams be set in order to function.
This is just an empty sub-interface to BuildLogger, but is used by Phing to throw graceful errors when classes like phing.listener.DefaultLogger are being used as -listener.
- Author
- Hans Lellelid
- Package
- phing
- See
- \BuildEvent
- See
- \Project::addBuildListener()
- Version
- $Id$
\StreamRequiredBuildLogger
Interface for build loggers that require that out/err streams be set in order to function.
This is just an empty sub-interface to BuildLogger, but is used by Phing to throw graceful errors when classes like phing.listener.DefaultLogger are being used as -listener.
- Parent(s)
- \BuildLogger < \BuildListener
- Children
- \DefaultLogger
- See
- \BuildEvent
- See
- \Project::addBuildListener()
- Author
- Hans Lellelid
- Version
- $Id$
Methods


buildFinished(
\BuildEvent $event
)
:
void
Fired after the last target has finished.
Inherited from: \BuildListener::buildFinished()\BuildLogger::buildFinished()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |


buildStarted(
\BuildEvent $event
)
:
void
Fired before any targets are started.
Inherited from: \BuildListener::buildStarted()\BuildLogger::buildStarted()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |


messageLogged(
\BuildEvent $event
)
:
void
Fired whenever a message is logged.
Inherited from: \BuildListener::messageLogged()\BuildLogger::messageLogged()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |


setErrorStream(
\OutputStream $err
)
:
void
Name | Type | Description |
---|---|---|
$err | \OutputStream | Configured output stream (e.g. STDERR) for errors. |


setMessageOutputLevel(
int $level
)
:
void
Sets the min log level that this logger should respect.
Inherited from: \BuildLogger::setMessageOutputLevel()Messages below this level are ignored.
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
Name | Type | Description |
---|---|---|
$level | int | The log level integer (e.g. Project::MSG_VERBOSE, etc.). |


setOutputStream(
\OutputStream $output
)
:
void
Name | Type | Description |
---|---|---|
$output | \OutputStream | Configured output stream (e.g. STDOUT) for standard output. |


targetFinished(
\BuildEvent $event
)
:
void
Fired when a target has finished.
Inherited from: \BuildListener::targetFinished()\BuildLogger::targetFinished()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |
- See
- \BuildEvent#getException()


targetStarted(
\BuildEvent $event
)
:
void
Fired when a target is started.
Inherited from: \BuildListener::targetStarted()\BuildLogger::targetStarted()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |


taskFinished(
\BuildEvent $event
)
:
void
Fired when a task has finished.
Inherited from: \BuildListener::taskFinished()\BuildLogger::taskFinished()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |


taskStarted(
\BuildEvent $event
)
:
void
Fired when a task is started.
Inherited from: \BuildListener::taskStarted()\BuildLogger::taskStarted()Name | Type | Description |
---|---|---|
$event | \BuildEvent | The BuildEvent |