[Sommaire] [Imprimer]

   1  <?php
   2  /*
   3   *  $Id: BuildListener.php 3076 2006-12-18 08:52:12Z fabien $
   4   *
   5   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16   *
  17   * This software consists of voluntary contributions made by many individuals
  18   * and is licensed under the LGPL. For more information please see
  19   * <http://phing.info>.
  20   */
  21  
  22  /**
  23   * Interface for build listeners.
  24   *
  25   * Classes that implement a listener must extend this class and (faux)implement
  26   * all methods that are decleard as dummies below.
  27   *
  28   * @author    Andreas Aderhold <andi@binarycloud.com>
  29   * @author    Hans Lellelid <hans@xmpl.org>
  30   * @version   $Revision: 1.6 $
  31   * @see       BuildEvent
  32   * @see       Project::addBuildListener()
  33   * @package   phing
  34   */
  35  interface BuildListener {
  36  
  37      /**
  38       * Fired before any targets are started.
  39       *
  40       * @param BuildEvent The BuildEvent
  41       */
  42      function buildStarted(BuildEvent $event);
  43  
  44      /**
  45       * Fired after the last target has finished.
  46       *
  47       * @param BuildEvent The BuildEvent
  48       * @see BuildEvent::getException()
  49       */
  50      function buildFinished(BuildEvent $event);
  51  
  52      /**
  53       * Fired when a target is started.
  54       *
  55       * @param BuildEvent The BuildEvent
  56       * @see BuildEvent::getTarget()
  57       */
  58      function targetStarted(BuildEvent $event);
  59  
  60      /**
  61       * Fired when a target has finished.
  62       *
  63       * @param BuildEvent The BuildEvent
  64       * @see BuildEvent#getException()
  65       */
  66      function targetFinished(BuildEvent $event);
  67  
  68      /**
  69       * Fired when a task is started.
  70       *
  71       * @param BuildEvent The BuildEvent
  72       * @see BuildEvent::getTask()
  73       */
  74      function taskStarted(BuildEvent $event);
  75  
  76      /**
  77       *  Fired when a task has finished.
  78       *
  79       *  @param BuildEvent The BuildEvent
  80       *  @see BuildEvent::getException()
  81       */
  82      function taskFinished(BuildEvent $event);
  83  
  84      /**
  85       *  Fired whenever a message is logged.
  86       *
  87       *  @param BuildEvent The BuildEvent
  88       *  @see BuildEvent::getMessage()
  89       */
  90      function messageLogged(BuildEvent $event);
  91  }