Docs For Class SimpleScorer

SimpleScorer

Description

Can receive test events and display them. Display is achieved by making display methods available and visiting the incoming event.

abstract:

Located in /scorer.php (line 21)

Direct descendents

Class	Description
SimpleReporter	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.
EclipseReporter	base reported class for eclipse plugin

Variable Summary

mixed $_exceptions

mixed $_fails

mixed $_is_dry_run

mixed $_passes

Method Summary

SimpleScorer SimpleScorer ()

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

integer getExceptionCount ()

integer getFailCount ()

integer getPassCount ()

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)

void paintSignal (string $type, mixed $payload)

void paintSkip (string $message)

void shouldInvoke (string $test_case_name, string $method)

Variables

mixed $_exceptions (line 24)

mixed $_fails (line 23)

mixed $_is_dry_run (line 25)

mixed $_passes (line 22)

Methods

Constructor SimpleScorer (line 31)

Starts the test run with no results.

access: public

SimpleScorer SimpleScorer ()

createInvoker (line 66)

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

Redefined in descendants as:

EclipseReporter::createInvoker() : Wraps the test in an output buffer.

getExceptionCount (line 202)

Accessor for the number of untrapped errors so far.

return: Number of exceptions.
access: public

integer getExceptionCount ()

getFailCount (line 192)

Accessor for the number of fails so far.

return: Number of fails.
access: public

integer getFailCount ()

getPassCount (line 183)

Accessor for the number of passes so far.

return: Number of passes.
access: public

integer getPassCount ()

getStatus (line 77)

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

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

Paints the end of a test case.

access: public

void paintCaseEnd (string $test_name)

string $test_name: Name of test or other label.

Redefined in descendants as:

SimpleReporter::paintCaseEnd() : Paints the end of a test case. Will paint the page footer if the stack of tests has unwound.
TreemapRecorder::paintCaseEnd() : acceptor for end of test case
JUnitXMLReporter::paintCaseEnd()
TestDoxReporter::paintCaseEnd()
XmlReporter::paintCaseEnd() : Paints the end of a test case.
EclipseReporter::paintCaseEnd() : Drops the name.

paintCaseStart (line 106)

Paints the start of a test case.

access: public

void paintCaseStart (string $test_name)

string $test_name: Name of test or other label.

Redefined in descendants as:

SimpleReporter::paintCaseStart() : 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.
TreemapRecorder::paintCaseStart() : acceptor for start of test case node
JUnitXMLReporter::paintCaseStart()
TestDoxReporter::paintCaseStart()
WebUnitReporter::paintCaseStart() : 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.
XmlReporter::paintCaseStart() : Paints the start of a test case.
EclipseReporter::paintCaseStart() : Stashes the test case name for the later failure message.

paintError (line 157)

Deals with PHP 4 throwing an error.

access: public

void paintError (string $message)

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

Redefined in descendants as:

HtmlReporter::paintError() : Paints a PHP error.
TextReporter::paintError() : Paints a PHP error or exception.
XmlReporter::paintError() : Paints error as XML.
EclipseReporter::paintError() : Stash the first error. Clicking the test item goes to first error.

paintException (line 166)

Deals with PHP 5 throwing an exception.

access: public

void paintException (Exception $exception)

Exception $exception: The actual exception thrown.

Redefined in descendants as:

JUnitXMLReporter::paintException()
WebUnitReporter::paintException() : Paints a PHP error or exception.
HtmlReporter::paintException() : Paints a PHP exception.
TextReporter::paintException() : Paints a PHP error or exception.
XmlReporter::paintException() : Paints exception as XML.
EclipseReporter::paintException() : Stash the first exception. Clicking the test item goes to first message.

paintFail (line 147)

Increments the fail count.

access: public

void paintFail (string $message)

string $message: Message is ignored.

Redefined in descendants as:

TreemapRecorder::paintFail() : acceptor for failing assertion node
JUnitXMLReporter::paintFail()
TestDoxReporter::paintFail()
WebUnitReporter::paintFail() : Paints the test failure with a breadcrumbs trail of the nesting test suites below the top level test.
Recorder::paintFail()
HtmlReporter::paintFail() : Paints the test failure with a breadcrumbs trail of the nesting test suites below the top level test.
TextReporter::paintFail() : Paints the test failure as a stack trace.
XmlReporter::paintFail() : Paints failure as XML.
EclipseReporter::paintFail() : Stash the first failing item. Clicking the test item goes to first fail.

paintFormattedMessage (line 220)

Paints a formatted ASCII message such as a variable dump.

access: public

void paintFormattedMessage (string $message)

string $message: Text to display.

Redefined in descendants as:

TreemapRecorder::paintFormattedMessage()
WebUnitReporter::paintFormattedMessage() : Paints formatted text such as dumped variables.
HtmlReporter::paintFormattedMessage() : Paints formatted text such as dumped variables.
TextReporter::paintFormattedMessage() : Paints formatted text such as dumped variables.
XmlReporter::paintFormattedMessage() : Paints a formatted ASCII message such as a variable dump.

paintGroupEnd (line 98)

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:

SimpleReporter::paintGroupEnd() : Paints the end of a group test. Will paint the page footer if the stack of tests has unwound.
TreemapRecorder::paintGroupEnd() : acceptor for end of test group. final group pops the collected treemap nodes and assigns it to the internal graph property.
XmlReporter::paintGroupEnd() : Paints the end of a group test.
EclipseReporter::paintGroupEnd() : Paints coverage report if enabled.

paintGroupStart (line 90)

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:

SimpleReporter::paintGroupStart() : 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.
TreemapRecorder::paintGroupStart() : acceptor for start of test group node
WebUnitReporter::paintGroupStart() : 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.
XmlReporter::paintGroupStart() : Paints the start of a group test.
EclipseReporter::paintGroupStart() : Stashes the name of the test suite. Starts test coverage if enabled.

paintMessage (line 211)

Paints a simple supplementary message.

access: public

void paintMessage (string $message)

string $message: Text to display.

Redefined in descendants as:

XmlReporter::paintMessage() : Paints a simple supplementary message.

paintMethodEnd (line 130)

Paints the end of a test method.

access: public

void paintMethodEnd (string $test_name)

string $test_name: Name of test or other label.

Redefined in descendants as:

SimpleReporter::paintMethodEnd() : Paints the end of a test method. Will paint the page footer if the stack of tests has unwound.
TreemapRecorder::paintMethodEnd() : acceptor for end of method node
JUnitXMLReporter::paintMethodEnd()
TestDoxReporter::paintMethodEnd()
WebUnitReporter::paintMethodEnd() : Paints the end of a test method.
XmlReporter::paintMethodEnd() : Paints the end of a test method.
EclipseReporter::paintMethodEnd() : Only send one message if the test passes, after that suppress the message.

paintMethodStart (line 122)

Paints the start of a test method.

access: public

void paintMethodStart (string $test_name)

string $test_name: Name of test or other label.

Redefined in descendants as:

SimpleReporter::paintMethodStart() : Paints the start of a test method.
TreemapRecorder::paintMethodStart() : acceptor for start of test method node
JUnitXMLReporter::paintMethodStart()
TestDoxReporter::paintMethodStart()
WebUnitReporter::paintMethodStart() : Paints the start of a test method.
XmlReporter::paintMethodStart() : Paints the start of a test method.
EclipseReporter::paintMethodStart() : Paints nothing at the start of a test method, but stash the method name for later.

paintPass (line 138)

Increments the pass count.

access: public

void paintPass (string $message)

string $message: Message is ignored.

Redefined in descendants as:

TreemapRecorder::paintPass() : acceptor for passing assertion node
Recorder::paintPass()
XmlReporter::paintPass() : Paints pass as XML.
EclipseReporter::paintPass() : Stash the first passing item. Clicking the test item goes to first pass.

paintSignal (line 229)

By default just ignores user generated events.

access: public

void paintSignal (string $type, mixed $payload)

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

Redefined in descendants as:

XmlReporter::paintSignal() : Serialises the event object.

paintSkip (line 175)

Prints the message for skipping tests.

access: public

void paintSkip (string $message)

string $message: Text of skip condition.

Redefined in descendants as:

HtmlReporter::paintSkip() : Prints the message for skipping tests.
TextReporter::paintSkip() : Prints the message for skipping tests.
XmlReporter::paintSkip() : Paints the skipping message and tag.

shouldInvoke (line 55)

The reporter has a veto on what should be run.

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