listener/PearLogListener.php

Show:

inherited

Classes
- \PearLogListener

Table of Contents

Writes build messages to PEAR Log.

By default it will log to file in current directory w/ name 'phing.log'. You can customize this behavior by setting properties: - pear.log.type - pear.log.name - pear.log.ident (note that this class changes ident to project name) - pear.log.conf (note that array values are currently unsupported in Phing property files)

 phing -f build.xml -logger phing.listener.PearLogger -Dpear.log.type=file -Dpear.log.name=/path/to/log.log

Author: Hans Lellelid
Package: phing.listener
See: \BuildEvent
Version: $Id$

\PearLogListener
jump to top

Package: phing\listener

Writes build messages to PEAR Log.

 phing -f build.xml -logger phing.listener.PearLogger -Dpear.log.type=file -Dpear.log.name=/path/to/log.log

Parent(s): \BuildListener
See: \BuildEvent
Author: Hans Lellelid
Version: $Id$

Constants

 
                LEFT_COLUMN_SIZE
                = 12

Size of the left column in output. The default char width is 12.

@var int

Properties

array
                 $levelMap= 'array( Project::MSG_DEBUG => PEAR_LOG_DEBUG,
                                        Project::MSG_INFO => PEAR_LOG_INFO,
                                        Project::MSG_VERBOSE => PEAR_LOG_NOTICE,
                                        Project::MSG_WARN => PEAR_LOG_WARNING,
                                        Project::MSG_ERR => PEAR_LOG_ERR
                                       )'

static

Maps Phing Project::MSG_* constants to PEAR_LOG_* constants.

Default value

array( Project::MSG_DEBUG => PEAR_LOG_DEBUG,
                                        Project::MSG_INFO => PEAR_LOG_INFO,
                                        Project::MSG_VERBOSE => PEAR_LOG_NOTICE,
                                        Project::MSG_WARN => PEAR_LOG_WARNING,
                                        Project::MSG_ERR => PEAR_LOG_ERR
                                       )

Details

Type: array

boolean
                 $logConfigured= 'false'

Whether logging has been configured.

Default valuefalseDetails

Type: boolean

\Log
                 $logger= ''

PEAR Log object.

Details

Type: \Log


                 $startTime= ''

Time that the build started

@var int

Details

Type: n/a

Methods

buildFinished(
          \BuildEvent $event
          )
        
        :
          void

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

Parameters

Name	Type	Description
$event	\BuildEvent	The BuildEvent

Details

See: \BuildEvent::getException()

buildStarted(
          \BuildEvent $event
          )
        
        :
          void

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

Parameters

Name	Type	Description
$event	\BuildEvent	The BuildEvent

configureLogging(
          
          )
        
        :
          void

Configure the logger.

logger(
          
          )
        
        :
          \Log

Get the configured PEAR logger to use.

This method just ensures that logging has been configured and returns the configured logger.

Returns

Type	Description
\Log

messageLogged(
          \BuildEvent $event
          )
        
        :
          void

Logs a message to the configured PEAR logger.

Parameters

Name	Type	Description
$event	\BuildEvent	The BuildEvent

Details

See: \BuildEvent::getMessage()

targetFinished(
           $event
          )
        
        :
          void

Fired when a target has finished. We don't need specific action on this event. So the methods are empty.

@param BuildEvent The BuildEvent

Parameters

Name	Type	Description
$event

Details

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

targetStarted(
          \BuildEvent $event
          )
        
        :
          void

Logs the current target name

Parameters

Name	Type	Description
$event	\BuildEvent	The BuildEvent

Details

See: \BuildEvent::getTarget()

taskFinished(
          \BuildEvent $event
          )
        
        :
          void

Fired when a task has finished. We don't need specific action on this event. So the methods are empty.

Parameters

Name	Type	Description
$event	\BuildEvent	The BuildEvent

Details

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 BuildEvent The BuildEvent

Parameters

Name	Type	Description
$event

Details

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

listener/PearLogListener.php

\PearLogListenerjump to top

Constants

Properties

Methods

\PearLogListener
jump to top