src/PHPT/Reporter.php

   1 <?php
   2
   3 interface PHPT_Reporter
   4 {
   5     /**
   6      * Called when the Reporter is started from a PHPT_Suite
   7      *
   8      * Use this method to display any start specific messages, such as number of tests
   9      * to run, etc.
  10      *
  11      * @param PHPT_Suite $suite
  12      * @return string
  13      */
  14     public function onSuiteStart(PHPT_Suite $suite);
  15
  16     /**
  17      * Called when the Reporter is finished in a PHPT_Suite
  18      *
  19      * Use this method to display any end specific messages such as pass/fail/skip tallies,
  20      * time run, etc.
  21      *
  22      * @param PHPT_Suite $suite
  23      * @return string
  24      */
  25     public function onSuiteEnd(PHPT_Suite $suite);
  26
  27     /**
  28      * Called when a Case is started
  29      *
  30      * @param PHPT_Case $case
  31      * @return string
  32      */
  33     public function onCaseStart(PHPT_Case $case);
  34
  35     /**
  36      * Called when a Case ends
  37      *
  38      * @param PHPT_Case $case
  39      * @return string
  40      */
  41     public function onCaseEnd(PHPT_Case $case);
  42
  43     /**
  44      * Called when a Case runs without Exception
  45      *
  46      * @param PHPT_Case $case
  47      * @return string
  48      */
  49     public function onCasePass(PHPT_Case $case);
  50
  51     /**
  52      * Called when a PHPT_Case_VetoException is thrown during a Case's run()
  53      *
  54      * @param PHPT_Case $case
  55      * @param PHPT_Case_VetoException $veto
  56      * @return string
  57      */
  58     public function onCaseSkip(PHPT_Case $case, PHPT_Case_VetoException $veto);
  59
  60     /**
  61      * Called when any Exception other than a PHPT_Case_VetoException is encountered
  62      * during a Case's run()
  63      *
  64      * @param PHPT_Case $case
  65      * @param PHPT_Case_FailureException $failure
  66      * @return string
  67      */
  68     public function onCaseFail(PHPT_Case $case, PHPT_Case_FailureException $failure);
  69
  70     public function onParserError(Exception $exception);
  71 }