Testing_DocTest
[ class tree: Testing_DocTest ] [ index: Testing_DocTest ] [ all elements ]

Source for file ReporterInterface.php

Documentation is available at ReporterInterface.php

  1. <?php
  2.  
  3. /* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
  4.  
  5. /**
  6.  * This file is part of the PEAR Testing_DocTest package.
  7.  *
  8.  * PHP version 5
  9.  *
  10.  * LICENSE: This source file is subject to the MIT license that is available
  11.  * through the world-wide-web at the following URI:
  12.  * http://opensource.org/licenses/mit-license.php
  13.  *
  14.  * @category  Testing
  15.  * @package   Testing_DocTest
  16.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  17.  * @copyright 2008 David JEAN LOUIS
  18.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  19.  * @version   CVS: $Id$
  20.  * @link      http://pear.php.net/package/Testing_DocTest
  21.  * @since     File available since release 0.1.0
  22.  * @filesource
  23.  */
  24.  
  25. /**
  26.  * DocTest Reporter interface.
  27.  * All reporters must implement this interface.
  28.  *
  29.  * @category  Testing
  30.  * @package   Testing_DocTest
  31.  * @author    David JEAN LOUIS <izimobil@gmail.com>
  32.  * @copyright 2008 David JEAN LOUIS
  33.  * @license   http://opensource.org/licenses/mit-license.php MIT License
  34.  * @version   Release: 0.6.0
  35.  * @link      http://pear.php.net/package/Testing_DocTest
  36.  * @since     Class available since release 0.1.0
  37.  */
  38. {
  39.     // onBegin() {{{
  40.  
  41.     /**
  42.      * Called when a doctest session begins.
  43.      *
  44.      * @param array $suites an array of Testing_DocTest_TestSuite instances
  45.      *
  46.      * @access public
  47.      * @return void 
  48.      */
  49.     public function onBegin(array $suites);
  50.  
  51.     // }}}
  52.     // onTestSuiteBegin() {{{
  53.  
  54.     /**
  55. /**
  56.      * Called before the runner starts running a suite.
  57.      *
  58.      * @param object $suite an instance of Testing_DocTest_TestSuite
  59.      *
  60.      * @access public
  61.      * @return void 
  62.      */
  63.     public function onTestSuiteBegin(Testing_DocTest_TestSuite $suite);
  64.  
  65.     // }}}
  66.     // onTestCaseBegin() {{{
  67.  
  68.     /**
  69.      * Called before the runner run a test case.
  70.      *
  71.      * @param object $case a test case instance
  72.      *
  73.      * @access public
  74.      * @return void 
  75.      */
  76.     public function onTestCaseBegin(Testing_DocTest_TestCase $case);
  77.  
  78.     // }}}
  79.     // onTestCasePass() {{{
  80.  
  81.     /**
  82.      * Called when a test passed.
  83.      *
  84.      * @param object $case a test case instance
  85.      *
  86.      * @access public
  87.      * @return void 
  88.      */
  89.     public function onTestCasePass(Testing_DocTest_TestCase $case);
  90.  
  91.     // }}}
  92.     // onTestCaseSkip() {{{
  93.  
  94.     /**
  95.      * Called when a test was skipped by the runner.
  96.      *
  97.      * @param object $case a test case instance
  98.      *
  99.      * @access public
  100.      * @return void 
  101.      */
  102.     public function onTestCaseSkip(Testing_DocTest_TestCase $case);
  103.  
  104.     // }}}
  105.     // onTestCaseFail() {{{
  106.  
  107.     /**
  108.      * Called when a test failed.
  109.      *
  110.      * @param object $case a test case instance
  111.      *
  112.      * @access public
  113.      * @return void 
  114.      */
  115.     public function onTestCaseFail(Testing_DocTest_TestCase $case);
  116.  
  117.     // }}}
  118.     // onTestCaseError() {{{
  119.  
  120.     /**
  121.      * Called when a test has errors.
  122.      *
  123.      * @param object $case a test case instance
  124.      *
  125.      * @access public
  126.      * @return void 
  127.      */
  128.     public function onTestCaseError(Testing_DocTest_TestCase $case);
  129.  
  130.     // }}}
  131.     // onTestCaseEnd() {{{
  132.  
  133.     /**
  134.      * Called when the runner finished a test case.
  135.      *
  136.      * @param object $case a test case instance
  137.      *
  138.      * @access public
  139.      * @return void 
  140.      */
  141.     public function onTestCaseEnd(Testing_DocTest_TestCase $case);
  142.  
  143.     // }}}
  144.     // onTestSuiteEnd() {{{
  145.  
  146.     /**
  147.      * Called when the runner finished running the suite.
  148.      *
  149.      * @param object $suite an instance of Testing_DocTest_TestSuite
  150.      *
  151.      * @access public
  152.      * @return void 
  153.      */
  154.     public function onTestSuiteEnd(Testing_DocTest_TestSuite $suite);
  155.  
  156.     // }}}
  157.     // onEnd() {{{
  158.  
  159.     /**
  160.      * Called at the end of the DocTest session.
  161.      *
  162.      * @param array $suites an array of Testing_DocTest_TestSuite instances
  163.      *
  164.      * @access public
  165.      * @return int 
  166.      */
  167.     public function onEnd(array $suites);
  168.  
  169.     // }}}
  170. }

Documentation generated on Thu, 17 Jan 2013 10:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.