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 /scorer.php (line 241)

SimpleScorer
   |
   --SimpleReporter
Direct descendents
Class Description
 class WebUnitReporter Sample minimal test displayer. Generates only failure messages and a pass count.
 class TestDoxReporter TestDox reporter
 class JUnitXMLReporter Reporter which outputs test results in a format compatible with JUnit / Maven XML output. Can be used for integrating test suite with continuous integration servers such as Atlassian Bamboo.
 class TreemapRecorder Collects SimpleReporter messages and constructs a TreemapNode graph.
 class HtmlReporter Sample minimal test displayer. Generates only failure messages and a pass count.
 class TextReporter Sample minimal test displayer. Generates only
 class XmlReporter Creates the XML needed for remote communication by SimpleTest.
Method Summary
 static boolean inCli ()
 SimpleReporter __construct ()
 integer getTestCaseCount ()
 integer getTestCaseProgress ()
 array getTestList ()
 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)
Methods
static inCli (line 406)

Static check for running in the comand line.

  • return: True if CLI.
  • access: public
boolean inCli ()
Constructor __construct (line 250)

Starts the display with no results in.

  • access: public
SimpleReporter __construct ()

Redefinition of:
SimpleScorer::__construct()
Starts the test run with no results.

Redefined in descendants as:
getDumper (line 262)

Gets the formatter for small generic data items.

  • return: Formatter.
  • access: public
SimpleDumper getDumper ()
getTestCaseCount (line 387)

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 397)

Accessor for the number of test cases completed so far.

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

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 ()
paintCaseEnd (line 323)

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:
SimpleScorer::paintCaseEnd()
Paints the end of a test case.

Redefined in descendants as:
paintCaseStart (line 307)

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:
SimpleScorer::paintCaseStart()
Paints the start of a test case.

Redefined in descendants as:
paintFooter (line 366)

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 292)

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:
SimpleScorer::paintGroupEnd()
Paints the end of a group test.

Redefined in descendants as:
paintGroupStart (line 275)

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:
SimpleScorer::paintGroupStart()
Paints the start of a group test.

Redefined in descendants as:
paintHeader (line 357)

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 346)

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:
SimpleScorer::paintMethodEnd()
Paints the end of a test method.

Redefined in descendants as:
paintMethodStart (line 336)

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:
SimpleScorer::paintMethodStart()
Paints the start of a test method.

Redefined in descendants as:

Inherited Methods

Inherited From SimpleScorer

 SimpleScorer::__construct()
 SimpleScorer::createInvoker()
 SimpleScorer::getExceptionCount()
 SimpleScorer::getFailCount()
 SimpleScorer::getPassCount()
 SimpleScorer::getStatus()
 SimpleScorer::makeDry()
 SimpleScorer::paintCaseEnd()
 SimpleScorer::paintCaseStart()
 SimpleScorer::paintError()
 SimpleScorer::paintException()
 SimpleScorer::paintFail()
 SimpleScorer::paintFormattedMessage()
 SimpleScorer::paintGroupEnd()
 SimpleScorer::paintGroupStart()
 SimpleScorer::paintMessage()
 SimpleScorer::paintMethodEnd()
 SimpleScorer::paintMethodStart()
 SimpleScorer::paintPass()
 SimpleScorer::paintSignal()
 SimpleScorer::paintSkip()
 SimpleScorer::shouldInvoke()

Documentation generated on Sun, 31 Oct 2010 16:32:18 -0500 by phpDocumentor 1.4.3