Class SimpleReporter

Description

Recipient of generated test messages that can display page footers and headers. Also keeps track of the test nesting. This is the main base class on which to build the finished test (page based) displays.

Located in /libraries/pear/simpletest/runner.php (line 319)

SimpleRunner
   |
   --SimpleReporter
Direct descendents
Class Description
 class XmlReporter Creates the XML needed for remote communication by SimpleTest.
 class HtmlReporter Sample minimal test displayer. Generates only failure messages and a pass count.
 class TextReporter Sample minimal test displayer. Generates only
Variable Summary
 mixed $_progress
 mixed $_size
 mixed $_test_stack
Method Summary
 SimpleReporter SimpleReporter ()
 integer getTestCaseCount ()
 integer getTestCaseProgress ()
 array getTestList ()
 boolean inCli ()
 void paintCaseEnd (string $test_name)
 void paintCaseStart (string $test_name)
 void paintFooter (string $test_name)
 void paintGroupEnd (string $test_name, integer $progress)
 void paintGroupStart (string $test_name, integer $size)
 void paintHeader (string $test_name)
 void paintMethodEnd (string $test_name)
 void paintMethodStart (string $test_name)
Variables
mixed $_progress (line 322)
mixed $_size (line 321)
mixed $_test_stack (line 320)

Inherited Variables

Inherited from SimpleRunner

SimpleRunner::$_exceptions
SimpleRunner::$_fails
SimpleRunner::$_is_dry_run
SimpleRunner::$_passes
Methods
Constructor SimpleReporter (line 328)

Starts the display with no results in.

  • access: public
SimpleReporter SimpleReporter ()
getTestCaseCount (line 456)

Accessor for total test size in number of test cases. Null until the first test is started.

  • return: Total number of cases at start.
  • access: public
integer getTestCaseCount ()
getTestCaseProgress (line 466)

Accessor for the number of test cases completed so far.

  • return: Number of ended cases.
  • access: public
integer getTestCaseProgress ()
getTestList (line 445)

Accessor for internal test stack. For subclasses that need to see the whole test history for display purposes.

  • return: List of methods in nesting order.
  • access: public
array getTestList ()
inCli (line 476)

Static check for running in the comand line.

  • return: True if CLI.
  • static:
  • access: public
boolean inCli ()
paintCaseEnd (line 392)

Paints the end of a test case. Will paint the page footer if the stack of tests has unwound.

  • access: public
void paintCaseEnd (string $test_name)
  • string $test_name: Name of test that is ending.

Redefinition of:
SimpleRunner::paintCaseEnd()
Paints the end of a test case.

Redefined in descendants as:
paintCaseStart (line 376)

Paints the start of a test case. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.

  • access: public
void paintCaseStart (string $test_name)
  • string $test_name: Name of test that is starting.

Redefinition of:
SimpleRunner::paintCaseStart()
Paints the start of a test case.

Redefined in descendants as:
paintFooter (line 435)

Paints the test document footer.

  • abstract:
  • access: public
void paintFooter (string $test_name)
  • string $test_name: The top level test.

Redefined in descendants as:
paintGroupEnd (line 361)

Paints the end of a group test. Will paint the page footer if the stack of tests has unwound.

  • access: public
void paintGroupEnd (string $test_name, integer $progress)
  • string $test_name: Name of test that is ending.
  • integer $progress: Number of test cases ending.

Redefinition of:
SimpleRunner::paintGroupEnd()
Paints the end of a group test.

Redefined in descendants as:
paintGroupStart (line 344)

Paints the start of a group test. Will also paint the page header and footer if this is the first test. Will stash the size if the first start.

  • access: public
void paintGroupStart (string $test_name, integer $size)
  • string $test_name: Name of test that is starting.
  • integer $size: Number of test cases starting.

Redefinition of:
SimpleRunner::paintGroupStart()
Paints the start of a group test.

Redefined in descendants as:
paintHeader (line 426)

Paints the test document header.

  • abstract:
  • access: public
void paintHeader (string $test_name)
  • string $test_name: First test top level to start.

Redefined in descendants as:
paintMethodEnd (line 415)

Paints the end of a test method. Will paint the page footer if the stack of tests has unwound.

  • access: public
void paintMethodEnd (string $test_name)
  • string $test_name: Name of test that is ending.

Redefinition of:
SimpleRunner::paintMethodEnd()
Paints the end of a test method.

Redefined in descendants as:
paintMethodStart (line 405)

Paints the start of a test method.

  • access: public
void paintMethodStart (string $test_name)
  • string $test_name: Name of test that is starting.

Redefinition of:
SimpleRunner::paintMethodStart()
Paints the start of a test method.

Redefined in descendants as:

Inherited Methods

Inherited From SimpleRunner

 SimpleRunner::SimpleRunner()
 SimpleRunner::getExceptionCount()
 SimpleRunner::getFailCount()
 SimpleRunner::getPassCount()
 SimpleRunner::getStatus()
 SimpleRunner::invoke()
 SimpleRunner::makeDry()
 SimpleRunner::paintCaseEnd()
 SimpleRunner::paintCaseStart()
 SimpleRunner::paintError()
 SimpleRunner::paintException()
 SimpleRunner::paintFail()
 SimpleRunner::paintFormattedMessage()
 SimpleRunner::paintGroupEnd()
 SimpleRunner::paintGroupStart()
 SimpleRunner::paintMessage()
 SimpleRunner::paintMethodEnd()
 SimpleRunner::paintMethodStart()
 SimpleRunner::paintPass()
 SimpleRunner::paintSignal()

Documentation generated on Thu, 20 Jan 2005 17:10:45 +0000 by phpDocumentor 1.3.0RC3