listener/NoBannerLogger.php

Show:

inherited

Classes
- \NoBannerLogger

Table of Contents

Extends DefaultLogger to strip out empty targets.

@author Andreas Aderhold andi@binarycloud.com

Copyright: 2001,2002 THYRELL. All rights reserved
Package: phing.listener
Version: $Id$

\NoBannerLogger
jump to top

Package: phing\listener

Extends DefaultLogger to strip out empty targets.

@author Andreas Aderhold andi@binarycloud.com

Parent(s): \DefaultLogger < \StreamRequiredBuildLogger < \BuildLogger < \BuildListener
Author: Andreas Aderhold
Copyright: 2001,2002 THYRELL. All rights reserved
Version: $Id$

Constants

 
                LEFT_COLUMN_SIZE
                = 12

inherited

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= ''

inherited

Stream to use for error output.Inherited from: \DefaultLogger::$$err

Details

Type: \OutputStream
Inherited_from: \DefaultLogger::$$err


                 $msgOutputLevel= 'Project::MSG_ERR'

inherited

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

Inherited from: \DefaultLogger::$$msgOutputLevel

@var int

Default valueProject::MSG_ERRDetails

Type: n/a
Inherited_from: \DefaultLogger::$$msgOutputLevel

\OutputStream
                 $out= ''

inherited

Stream to use for standard output.Inherited from: \DefaultLogger::$$out

Details

Type: \OutputStream
Inherited_from: \DefaultLogger::$$out


                 $startTime= ''

inherited

Time that the build started

Inherited from: \DefaultLogger::$$startTime

@var int

Details

Type: n/a
Inherited_from: \DefaultLogger::$$startTime


                 $targetName= 'null'

Default valuenullDetails

Type: n/a

Methods

__construct(
          
          )
        
        :
          void

inherited

Construct a new default logger.

Inherited from: \DefaultLogger::__construct()

buildFinished(
           $event
          )
        
        :
          void

inherited

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

Inherited from: \DefaultLogger::buildFinished()

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

See: \BuildEvent::getException()

buildStarted(
           $event
          )
        
        :
          void

inherited

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

Inherited from: \DefaultLogger::buildStarted()

@param object The BuildEvent

Parameters

Name	Type	Description
$event

Details

Access: public

formatTime(
           $micros
          )
        
        :
          void

staticinherited

Formats a time micro integer to human readable format.

Inherited from: \DefaultLogger::formatTime()

@param integer The time stamp

Parameters

Name	Type	Description
$micros

Details

Access: private

getBuildFailedMessage(
          
          )
        
        :
          string

inherited

Get the message to return when a build failed.

Inherited from: \DefaultLogger::getBuildFailedMessage()

Returns

Type	Description
string	The classic "BUILD FAILED"

getBuildSuccessfulMessage(
          
          )
        
        :
          string

inherited

Get the message to return when a build succeeded.

Inherited from: \DefaultLogger::getBuildSuccessfulMessage()

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

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

inherited

Prints a message to console.

Inherited from: \DefaultLogger::printMessage()

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

inherited

Sets the error stream.

Inherited from: \DefaultLogger::setErrorStream()

Parameters

Name	Type	Description
$err	\OutputStream

Details

See: \BuildLogger#setErrorStream()

setMessageOutputLevel(
          int $level
          )
        
        :
          void

inherited

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.

Parameters

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

Details

See: \BuildLogger#setMessageOutputLevel()

setOutputStream(
          \OutputStream $output
          )
        
        :
          void

inherited

Sets the output stream.

Inherited from: \DefaultLogger::setOutputStream()

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

targetStarted(
           $event
          )
        
        :
          void

Prints the current target name

@param object The BuildEvent

Parameters

Name	Type	Description
$event

taskFinished(
           $event
          )
        
        :
          void

inherited

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

Parameters

Name	Type	Description
$event

Details

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

taskStarted(
           $event
          )
        
        :
          void

inherited

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

Parameters

Name	Type	Description
$event

Details

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

listener/NoBannerLogger.php

\NoBannerLoggerjump to top

Constants

Properties

Methods

\NoBannerLogger
jump to top