Class SimpleReporterDecorator

Description

For modifying the behaviour of the visual reporters.

Located in /scorer.php (line 416)


	
			
Direct descendents
Class Description
 class TreemapReporter Constructs and renders a treemap visualization of a test run
 class SelectiveReporter Runs just a single test group, a single case or even a single test within that case.
 class NoSkipsReporter Suppresses skip messages.
 class DefaultReporter The default reporter used by SimpleTest's autorun feature. The actual reporters used are dependency injected and can be overridden.
 class Recorder Array-based test recorder. Returns an array with timestamp, status, test name and message for each pass and failure.
Variable Summary
 mixed $reporter
Method Summary
 SimpleReporterDecorator __construct (SimpleScorer $reporter)
 boolean getStatus ()
 array getTestList ()
 void makeDry ([boolean $is_dry = true])
 void paintCaseEnd (string $test_name)
 void paintCaseStart (string $test_name)
 void paintError (string $message)
 void paintException (Exception $exception)
 void paintFail (string $message)
 void paintFormattedMessage (string $message)
 void paintGroupEnd (string $test_name)
 void paintGroupStart (string $test_name, integer $size)
 void paintMessage (string $message)
 void paintMethodEnd (string $test_name)
 void paintMethodStart (string $test_name)
 void paintPass (string $message)
 boolean paintSignal (string $type, mixed $payload)
 void paintSkip (string $message)
 boolean shouldInvoke (string $test_case_name, string $method)
Variables
mixed $reporter (line 417)
  • access: protected
Methods
Constructor __construct (line 423)

Mediates between the reporter and the test case.

SimpleReporterDecorator __construct (SimpleScorer $reporter)

Redefined in descendants as:
createInvoker (line 481)

Can wrap the invoker in preparation for running a test.

  • return: Wrapped test runner.
  • access: public
SimpleInvoker createInvoker (SimpleInvoker $invoker)
getDumper (line 491)

Gets the formatter for privateiables and other small generic data items.

  • return: Formatter.
  • access: public
SimpleDumper getDumper ()
getStatus (line 445)

Accessor for current status. Will be false if there have been any failures or exceptions.

Used for command line tools.

  • return: True if no failures.
  • access: public
boolean getStatus ()
getTestList (line 455)

The nesting of the test cases so far. Not all reporters have this facility.

  • return: Test list if accessible.
  • access: public
array getTestList ()
makeDry (line 434)

Signals that the next evaluation will be a dry run. That is, the structure events will be recorded, but no tests will be run.

  • access: public
void makeDry ([boolean $is_dry = true])
  • boolean $is_dry: Dry run if true.
paintCaseEnd (line 528)

Paints the end of a test case.

  • access: public
void paintCaseEnd (string $test_name)
  • string $test_name: Name of test or other label.
paintCaseStart (line 519)

Paints the start of a test case.

  • access: public
void paintCaseStart (string $test_name)
  • string $test_name: Name of test or other label.
paintError (line 574)

Chains to the wrapped reporter.

  • access: public
void paintError (string $message)
  • string $message: Text of error formatted by the test case.
paintException (line 583)

Chains to the wrapped reporter.

  • access: public
void paintException (Exception $exception)
  • Exception $exception: Exception to show.

Redefined in descendants as:
paintFail (line 564)

Chains to the wrapped reporter.

  • access: public
void paintFail (string $message)
  • string $message: Message is ignored.

Redefined in descendants as:
paintFormattedMessage (line 610)

Chains to the wrapped reporter.

  • access: public
void paintFormattedMessage (string $message)
  • string $message: Text to display.
paintGroupEnd (line 510)

Paints the end of a group test.

  • access: public
void paintGroupEnd (string $test_name)
  • string $test_name: Name of test or other label.

Redefined in descendants as:
paintGroupStart (line 501)

Paints the start of a group test.

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

Redefined in descendants as:
paintMessage (line 601)

Chains to the wrapped reporter.

  • access: public
void paintMessage (string $message)
  • string $message: Text to display.
paintMethodEnd (line 546)

Paints the end of a test method.

  • access: public
void paintMethodEnd (string $test_name)
  • string $test_name: Name of test or other label.
paintMethodStart (line 537)

Paints the start of a test method.

  • access: public
void paintMethodStart (string $test_name)
  • string $test_name: Name of test or other label.
paintPass (line 555)

Chains to the wrapped reporter.

  • access: public
void paintPass (string $message)
  • string $message: Message is ignored.

Redefined in descendants as:
paintSignal (line 623)

Chains to the wrapped reporter.

  • return: Should return false if this type of signal should fail the test suite.
  • access: public
boolean paintSignal (string $type, mixed $payload)
  • string $type: Event type as text.
  • mixed $payload: Message or object.
paintSkip (line 592)

Prints the message for skipping tests.

  • access: public
void paintSkip (string $message)
  • string $message: Text of skip condition.

Redefined in descendants as:
shouldInvoke (line 470)

The reporter has a veto on what should be run.

  • return: True if test should be run.
  • access: public
boolean shouldInvoke (string $test_case_name, string $method)
  • string $test_case_name: Name of test case.
  • string $method: Name of test method.

Redefined in descendants as:

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