HtmlReporter Class Reference

Inheritance diagram for HtmlReporter:
[legend]
Collaboration diagram for HtmlReporter:
[legend]

List of all members.


Public Member Functions

 HtmlReporter ($character_set= 'ISO-8859-1')
 paintHeader ($test_name)
 _getCss ()
 paintFooter ($test_name)
 paintFail ($message)
 paintError ($message)
 paintException ($exception)
 paintSkip ($message)
 paintFormattedMessage ($message)
 _htmlEntities ($message)

Static Public Member Functions

 sendNoCacheHeaders ()

Public Attributes

 $_character_set


Detailed Description

Definition at line 10 of file reporter.php.


Member Function Documentation

HtmlReporter::HtmlReporter ( character_set = 'ISO-8859-1'  ) 

Does nothing yet. The first output will be sent on the first test start. For use by a web browser. public

Definition at line 19 of file reporter.php.

References SimpleReporter::SimpleReporter().

Here is the call graph for this function:

HtmlReporter::paintHeader ( test_name  ) 

Paints the top of the web page setting the title to the name of the starting test.

Parameters:
string $test_name Name class of test. public

Reimplemented from SimpleReporter.

Definition at line 30 of file reporter.php.

References _getCss(), print, and sendNoCacheHeaders().

Here is the call graph for this function:

HtmlReporter::sendNoCacheHeaders (  )  [static]

Send the headers necessary to ensure the page is reloaded on every request. Otherwise you could be scratching your head over out of date test data. public

Definition at line 50 of file reporter.php.

Referenced by paintHeader().

HtmlReporter::_getCss (  ) 

Paints the CSS. Add additional styles here.

Returns:
string CSS code as text. protected

Definition at line 65 of file reporter.php.

Referenced by paintHeader().

HtmlReporter::paintFooter ( test_name  ) 

Paints the end of the test with a summary of the passes and failures.

Parameters:
string $test_name Name class of test. public

Reimplemented from SimpleReporter.

Definition at line 75 of file reporter.php.

References SimpleScorer::getExceptionCount(), SimpleScorer::getFailCount(), SimpleScorer::getPassCount(), SimpleReporter::getTestCaseCount(), SimpleReporter::getTestCaseProgress(), and print.

Here is the call graph for this function:

HtmlReporter::paintFail ( message  ) 

Paints the test failure with a breadcrumbs trail of the nesting test suites below the top level test.

Parameters:
string $message Failure message displayed in the context of the other tests. public

Reimplemented from SimpleScorer.

Definition at line 97 of file reporter.php.

References _htmlEntities(), SimpleReporter::getTestList(), and print.

Here is the call graph for this function:

HtmlReporter::paintError ( message  ) 

Paints a PHP error.

Parameters:
string $message Message is ignored. public

Reimplemented from SimpleScorer.

Definition at line 111 of file reporter.php.

References _htmlEntities(), SimpleReporter::getTestList(), and print.

Here is the call graph for this function:

HtmlReporter::paintException ( exception  ) 

Paints a PHP exception.

Parameters:
Exception $exception Exception to display. public

Reimplemented from SimpleScorer.

Definition at line 125 of file reporter.php.

References _htmlEntities(), SimpleReporter::getTestList(), and print.

Here is the call graph for this function:

HtmlReporter::paintSkip ( message  ) 

Prints the message for skipping tests.

Parameters:
string $message Text of skip condition. public

Reimplemented from SimpleScorer.

Definition at line 140 of file reporter.php.

References _htmlEntities(), SimpleReporter::getTestList(), and print.

Here is the call graph for this function:

HtmlReporter::paintFormattedMessage ( message  ) 

Paints formatted text such as dumped variables.

Parameters:
string $message Text to show. public

Reimplemented from SimpleScorer.

Definition at line 154 of file reporter.php.

References _htmlEntities(), and print.

Here is the call graph for this function:

HtmlReporter::_htmlEntities ( message  ) 

Character set adjusted entity conversion.

Parameters:
string $message Plain text or Unicode message.
Returns:
string Browser readable message. protected

Definition at line 164 of file reporter.php.

Referenced by paintError(), paintException(), paintFail(), paintFormattedMessage(), and paintSkip().


Member Data Documentation

HtmlReporter::$_character_set

Definition at line 11 of file reporter.php.


The documentation for this class was generated from the following file:

Generated on Mon Jun 2 15:09:09 2008 for SimpleTest by  1.5.5