listener/StreamRequiredBuildLogger.php

Show: inherited
    Table of Contents

    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

    Package: phing

    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

    methodpublicbuildFinished( \BuildEvent $event ) : void
    inherited

    Fired after the last target has finished.

    Inherited from: \BuildListener::buildFinished()\BuildLogger::buildFinished()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent::getException()  
    methodpublicbuildStarted( \BuildEvent $event ) : void
    inherited

    Fired before any targets are started.

    Inherited from: \BuildListener::buildStarted()\BuildLogger::buildStarted()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    methodpublicmessageLogged( \BuildEvent $event ) : void
    inherited

    Fired whenever a message is logged.

    Inherited from: \BuildListener::messageLogged()\BuildLogger::messageLogged()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent::getMessage()  
    methodpublicsetErrorStream( \OutputStream $err ) : void
    inherited

    Sets the output stream to use for errors.

    Inherited from: \BuildLogger::setErrorStream()
    Parameters
    Name Type Description
    $err \OutputStream

    Configured output stream (e.g. STDERR) for errors.

    methodpublicsetMessageOutputLevel( int $level ) : void
    inherited

    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

    Parameters
    Name Type Description
    $level int

    The log level integer (e.g. Project::MSG_VERBOSE, etc.).

    methodpublicsetOutputStream( \OutputStream $output ) : void
    inherited

    Sets the standard output stream to use.

    Inherited from: \BuildLogger::setOutputStream()
    Parameters
    Name Type Description
    $output \OutputStream

    Configured output stream (e.g. STDOUT) for standard output.

    methodpublictargetFinished( \BuildEvent $event ) : void
    inherited

    Fired when a target has finished.

    Inherited from: \BuildListener::targetFinished()\BuildLogger::targetFinished()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent#getException()  
    methodpublictargetStarted( \BuildEvent $event ) : void
    inherited

    Fired when a target is started.

    Inherited from: \BuildListener::targetStarted()\BuildLogger::targetStarted()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent::getTarget()  
    methodpublictaskFinished( \BuildEvent $event ) : void
    inherited

    Fired when a task has finished.

    Inherited from: \BuildListener::taskFinished()\BuildLogger::taskFinished()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent::getException()  
    methodpublictaskStarted( \BuildEvent $event ) : void
    inherited

    Fired when a task is started.

    Inherited from: \BuildListener::taskStarted()\BuildLogger::taskStarted()
    Parameters
    Name Type Description
    $event \BuildEvent

    The BuildEvent

    Details
    See
    \BuildEvent::getTask()  
    Documentation was generated by DocBlox 0.18.1.