Docs For Class MultipleReporter

MultipleReporter

Description

For sending messages to multiple reporters at the same time.

Located in /scorer.php (line 622)

Variable Summary

mixed $_reporters

Method Summary

void attachReporter ( &$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)

void shouldInvoke (string $test_case_name, string $method)

Variables

mixed $_reporters = array() (line 623)

Methods

attachReporter (line 630)

Adds a reporter to the subscriber list.

access: public

void attachReporter ( &$reporter, SimpleScorer $reporter)

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

createInvoker (line 686)

Every reporter gets a chance to wrap the invoker.

return: Wrapped test runner.
access: public

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

SimpleInvoker $invoker: Individual test runner.
&$invoker

getDumper (line 699)

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

return: Formatter.
access: public

SimpleDumper getDumper ()

getStatus (line 655)

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

If any reporter reports a failure, the whole suite fails.

return: True if no failures.
access: public

boolean getStatus ()

makeDry (line 641)

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

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

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

Chains to the wrapped reporter.

access: public

void paintError (string $message)

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

paintException (line 809)

Chains to the wrapped reporter.

access: public

void paintException (Exception $exception)

Exception $exception: Exception to display.

paintFail (line 786)

Chains to the wrapped reporter.

access: public

void paintFail (string $message)

string $message: Message is ignored.

paintFormattedMessage (line 842)

Chains to the wrapped reporter.

access: public

void paintFormattedMessage (string $message)

string $message: Text to display.

paintGroupEnd (line 720)

Paints the end of a group test.

access: public

void paintGroupEnd (string $test_name)

string $test_name: Name of test or other label.

paintGroupStart (line 709)

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.

paintMessage (line 831)

Chains to the wrapped reporter.

access: public

void paintMessage (string $message)

string $message: Text to display.

paintMethodEnd (line 764)

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

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

Chains to the wrapped reporter.

access: public

void paintPass (string $message)

string $message: Message is ignored.

paintSignal (line 857)

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

Prints the message for skipping tests.

access: public

void paintSkip (string $message)

string $message: Text of skip condition.

shouldInvoke (line 671)

The reporter has a veto on what should be run.

It requires all reporters to want to run the method.

access: public

void shouldInvoke (string $test_case_name, string $method)

string $test_case_name: name of test case.
string $method: Name of test method.

Documentation generated on Sun, 04 May 2008 09:22:04 -0500 by phpDocumentor 1.3.0