Docs For Class SimpleReporterDecorator

Description

For modifying the behaviour of the visual reporters.

Direct descendents

Class	Description
TreemapReporter	Constructs and renders a treemap visualization of a test run
SelectiveReporter	Runs just a single test group, a single case or even a single test within that case.
NoSkipsReporter	Suppresses skip messages.
DefaultReporter	The default reporter used by SimpleTest's autorun feature. The actual reporters used are dependency injected and can be overridden.

Variable Summary

mixed $_reporter

Method Summary

SimpleReporterDecorator SimpleReporterDecorator ( &$reporter, SimpleScorer $reporter)

SimpleInvoker &createInvoker ( &$invoker, SimpleInvoker $invoker)

SimpleDumper getDumper ()

boolean getStatus ()

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, &$payload, mixed $payload)

void paintSkip (string $message)

boolean shouldInvoke (string $test_case_name, string $method)

Variables

mixed $_reporter (line 419)

Methods

Constructor SimpleReporterDecorator (line 425)

Mediates between the reporter and the test case.

SimpleReporterDecorator SimpleReporterDecorator ( &$reporter, SimpleScorer $reporter)

SimpleScorer $reporter: Reporter to receive events.
&$reporter

createInvoker (line 469)

Can wrap the invoker in preperation for running a test.

return: Wrapped test runner.
access: public

SimpleInvoker &createInvoker ( &$invoker, SimpleInvoker $invoker)

SimpleInvoker $invoker: Individual test runner.
&$invoker

getDumper (line 479)

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

return: Formatter.
access: public

SimpleDumper getDumper ()

getStatus (line 447)

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

makeDry (line 436)

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

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

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

Chains to the wrapped reporter.

access: public

void paintError (string $message)

string $message: Text of error formatted by the test case.

paintException (line 571)

Chains to the wrapped reporter.

access: public

void paintException (Exception $exception)

Exception $exception: Exception to show.

paintFail (line 552)

Chains to the wrapped reporter.

access: public

void paintFail (string $message)

string $message: Message is ignored.

paintFormattedMessage (line 598)

Chains to the wrapped reporter.

access: public

void paintFormattedMessage (string $message)

string $message: Text to display.

paintGroupEnd (line 498)

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:

TreemapReporter::paintGroupEnd()
SelectiveReporter::paintGroupEnd() : Paints the end of a group test.

paintGroupStart (line 489)

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:

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

paintMessage (line 589)

Chains to the wrapped reporter.

access: public

void paintMessage (string $message)

string $message: Text to display.

paintMethodEnd (line 534)

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

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

Chains to the wrapped reporter.

access: public

void paintPass (string $message)

string $message: Message is ignored.

paintSignal (line 611)

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, &$payload, mixed $payload)

string $type: Event type as text.
mixed $payload: Message or object.
&$payload

paintSkip (line 580)

Prints the message for skipping tests.

access: public

void paintSkip (string $message)

string $message: Text of skip condition.

Redefined in descendants as:

NoSkipsReporter::paintSkip() : Does nothing.

shouldInvoke (line 458)

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:

SelectiveReporter::shouldInvoke() : Veto everything that doesn't match the method wanted.