listener/DefaultLogger.php

Show:

inherited

Classes
- \DefaultLogger

Table of Contents

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
Copyright: 2001,2002 THYRELL. All rights reserved
Package: phing.listener
See: \BuildEvent
Version: $Id$

\DefaultLogger
jump to top

Package: phing\listener

Writes a build event to the console.

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

Parent(s): \StreamRequiredBuildLogger < \BuildLogger < \BuildListener
Children: \HtmlColorLogger; \NoBannerLogger; \AnsiColorLogger; \MailLogger
See: \BuildEvent
Author: Andreas Aderhold
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.

@var int

Properties

\OutputStream
                 $err= ''

Stream to use for error output.

Details

Type: \OutputStream


                 $msgOutputLevel= 'Project::MSG_ERR'

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

@var int

Default valueProject::MSG_ERRDetails

Type: n/a

\OutputStream
                 $out= ''

Stream to use for standard output.

Details

Type: \OutputStream


                 $startTime= ''

Time that the build started

@var int

Details

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

Construct a new default logger.

buildFinished(
           $event
          )
        
        :
          void

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

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

See: \BuildEvent::getException()

buildStarted(
           $event
          )
        
        :
          void

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

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

Access: public

formatTime(
           $micros
          )
        
        :
          void

static

Formats a time micro integer to human readable format.

@param integer The time stamp

Parameters

Name	Type	Description
$micros

Details

Access: private

getBuildFailedMessage(
          
          )
        
        :
          string

Get the message to return when a build failed.

Returns

Type	Description
string	The classic "BUILD FAILED"

getBuildSuccessfulMessage(
          
          )
        
        :
          string

Get the message to return when a build succeeded.

Returns

Type	Description
string	The classic "BUILD FINISHED"

messageLogged(
           $event
          )
        
        :
          void

Print a message to the stdout.

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

Access: public
See: \BuildEvent::getMessage()

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

Prints a message to console.

Parameters

Name	Type	Description
$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.)

setErrorStream(
          \OutputStream $err
          )
        
        :
          void

Sets the error stream.

Parameters

Name	Type	Description
$err	\OutputStream

Details

See: \BuildLogger#setErrorStream()

setMessageOutputLevel(
          int $level
          )
        
        :
          void

Set the msgOutputLevel this logger is to respond to.

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.

Parameters

Name	Type	Description
$level	int	The logging level for the logger.

Details

See: \BuildLogger#setMessageOutputLevel()

setOutputStream(
          \OutputStream $output
          )
        
        :
          void

Sets the output stream.

Parameters

Name	Type	Description
$output	\OutputStream

Details

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.

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

See: \BuildEvent::getException()

targetStarted(
           $event
          )
        
        :
          void

Prints the current target name

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

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.

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

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.

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

Access: public
See: \BuildEvent::getTask()

listener/DefaultLogger.php

\DefaultLoggerjump to top

Constants

Properties

Methods

\DefaultLogger
jump to top