# BuildLogger.php

Interface for build loggers.

Build loggers are build listeners but with some additional functionality: - They can be configured with a log level (below which they will ignore messages) - They have error and output streams

Classes that implement a listener must implement this interface.

Author
  Hans Lellelid
Package
  phing
See
  \BuildEvent
See
  \Project::addBuildListener()
Version
  $Revision: 552 $

## \BuildLogger
jump to top

Package: phing

Interface for build loggers.

Build loggers are build listeners but with some additional functionality: - They can be configured with a log level (below which they will ignore messages) - They have error and output streams

Classes that implement a listener must implement this interface.

Parent(s)
  \BuildListener
Children
  \StreamRequiredBuildLogger
See
  \BuildEvent
See
  \Project::addBuildListener()
Author
  Hans Lellelid
Version
  $Revision: 552 $

### Methods

`buildFinished( \BuildEvent $event ) : void`
inherited

Fired after the last target has finished.

Inherited from: \BuildListener::buildFinished()
Parameters

Name | Type | Description
--- | --- | ---
$event | \BuildEvent | The BuildEvent

Details

See
  \BuildEvent::getException()

`buildStarted( \BuildEvent $event ) : void`
inherited

Fired before any targets are started.

Inherited from: \BuildListener::buildStarted()
Parameters

Name | Type | Description
--- | --- | ---
$event | \BuildEvent | The BuildEvent

`messageLogged( $event ) : void`
inherited

Fired whenever a message is logged.

Inherited from: \BuildListener::messageLogged()

@param BuildEvent The BuildEvent

Parameters

Name | Type | Description
--- | --- | ---
$event |  |

Details

See
  \BuildEvent::getMessage()

`setErrorStream( \OutputStream $err ) : void`

Sets the output stream to use for errors.

Parameters

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.

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

Parameters

Name | Type | Description
--- | --- | ---
$level | int | The log level integer (e.g. Project::MSG_VERBOSE, etc.).

`setOutputStream( \OutputStream $output ) : void`

Sets the standard output stream to use.

Parameters

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

`targetFinished( \BuildEvent $event ) : void`
inherited

Fired when a target has finished.

Inherited from: \BuildListener::targetFinished()
Parameters

Name | Type | Description
--- | --- | ---
$event | \BuildEvent | The BuildEvent

Details

See
  \BuildEvent#getException()

`targetStarted( \BuildEvent $event ) : void`
inherited

Fired when a target is started.

Inherited from: \BuildListener::targetStarted()
Parameters

Name | Type | Description
--- | --- | ---
$event | \BuildEvent | The BuildEvent

Details

See
  \BuildEvent::getTarget()

`taskFinished( $event ) : void`
inherited

Fired when a task has finished.

Inherited from: \BuildListener::taskFinished()

@param BuildEvent The BuildEvent

Parameters

Name | Type | Description
--- | --- | ---
$event |  |

Details

See
  \BuildEvent::getException()

`taskStarted( \BuildEvent $event ) : void`
inherited

Fired when a task is started.

Inherited from: \BuildListener::taskStarted()
Parameters

Name | Type | Description
--- | --- | ---
$event | \BuildEvent | The BuildEvent

Details

See
  \BuildEvent::getTask()

Documentation was generated by DocBlox 0.15.1.