Class CakeHtmlReporter

CakeHtmlReporter Reports Results of TestSuites and Test Cases in an HTML format / context.

PHPUnit_TextUI_ResultPrinter
Extended by CakeBaseReporter
Extended by CakeHtmlReporter
Package: Cake\TestSuite\Reporter
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/TestSuite/Reporter/CakeHtmlReporter.php

Method Detail

_getQueryLink( )

Returns the query string formatted for ouput in links

Returns

string
string

_getStackTracesource protected

_getStackTrace( Exception $e )

Gets a formatted stack trace.

Parameters

Exception $e
Exception to get a stack trace for.

Returns

string
Generated stack trace.

_htmlEntitiessource protected

_htmlEntities( string $message )

Character set adjusted entity conversion.

Parameters

string $message
Plain text or Unicode message.

Returns

string
Browser readable message.
_paintLinks( )

Renders the links that for accessing things in the test suite.

_queryStringsource protected

_queryString( array $url )

Convert an array of parameters into a query string url

Parameters

array $url
Url hash to be converted

Returns

string
Converted url query string

paintCoveragesource public

paintCoverage( array $coverage )

Paints a code coverage report.

Parameters

array $coverage
The coverage data

paintDocumentEndsource public

paintDocumentEnd( )

Paints the end of the document html.

Overrides

CakeBaseReporter::paintDocumentEnd()

paintDocumentStartsource public

paintDocumentStart( )

Paints the document start content contained in header.php

Overrides

CakeBaseReporter::paintDocumentStart()

paintExceptionsource public

paintException( Exception $message , mixed $test )

Paints a PHP exception.

Parameters

Exception $message
Exception to display.
mixed $test
The test that failed.

paintFailsource public

paintFail( PHPUnit_Framework_AssertionFailedError $message , mixed $test )

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

Parameters

PHPUnit_Framework_AssertionFailedError $message
Failure object displayed in the context of the other tests.
mixed $test
The test case to paint a failure for.

paintFootersource public

paintFooter( PHPUnit_Framework_TestResult $result )

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

Parameters

PHPUnit_Framework_TestResult $result
Result object

paintFormattedMessagesource public

paintFormattedMessage( string $message )

Paints formatted text such as dumped variables.

Parameters

string $message
Text to show.

paintHeadersource public

paintHeader( )

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

paintPasssource public

paintPass( PHPUnit_Framework_Test $test , float $time null )

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

Parameters

PHPUnit_Framework_Test $test
Test method that just passed
float $time optional null
time spent to run the test method

paintSkipsource public

paintSkip( string $message , PHPUnit_Framework_TestCase $test )

Prints the message for skipping tests.

Parameters

string $message
Text of skip condition.
PHPUnit_Framework_TestCase $test
the test method skipped

paintTestMenusource public

paintTestMenu( )

Paints the menu on the left side of the test suite interface. Contains all of the various plugin, core, and app buttons.

Overrides

CakeBaseReporter::paintTestMenu()

sendContentTypesource public

sendContentType( )

Set the content-type header so it is in the correct encoding.

sendNoCacheHeaderssource public

sendNoCacheHeaders( )

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.

startTestSuitesource public

startTestSuite( PHPUnit_Framework_TestSuite $suite )

A test suite started.

Parameters

PHPUnit_Framework_TestSuite $suite
The test suite to start.

Overrides

CakeBaseReporter::startTestSuite()

testCaseListsource public

testCaseList( )

Retrieves and paints the list of tests cases in an HTML format.

Overrides

CakeBaseReporter::testCaseList()

Methods inherited from CakeBaseReporter

__constructsource public

__construct( string $charset 'utf-8' , array $params array() )

Does nothing yet. The first output will be sent on the first test start.

Params

  • show_passes - Should passes be shown
  • plugin - Plugin test being run?
  • core - Core test being run.
  • case - The case being run
  • codeCoverage - Whether the case/group being run is being code covered.

Parameters

string $charset optional 'utf-8'
The character set to output with. Defaults to UTF-8
array $params optional array()
Array of request parameters the reporter should use. See above.

addErrorsource public

addError( PHPUnit_Framework_Test $test , Exception $e , float $time )

An error occurred.

Parameters

PHPUnit_Framework_Test $test
The test to add an error for.
Exception $e
The exception object to add.
float $time
The current time.

addFailuresource public

addFailure( PHPUnit_Framework_Test $test , PHPUnit_Framework_AssertionFailedError $e , float $time )

A failure occurred.

Parameters

PHPUnit_Framework_Test $test
The test that failed
PHPUnit_Framework_AssertionFailedError $e
The assertion that failed.
float $time
The current time.

addIncompleteTestsource public

addIncompleteTest( PHPUnit_Framework_Test $test , Exception $e , float $time )

Incomplete test.

Parameters

PHPUnit_Framework_Test $test
The test that was incomplete.
Exception $e
The incomplete exception
float $time
The current time.

addSkippedTestsource public

addSkippedTest( PHPUnit_Framework_Test $test , Exception $e , float $time )

Skipped test.

Parameters

PHPUnit_Framework_Test $test
The test that failed.
Exception $e
The skip object.
float $time
The current time.

baseUrlsource public

baseUrl( )

Get the baseUrl if one is available.

Returns

string
The base URL for the request.

endTestsource public

endTest( PHPUnit_Framework_Test $test , float $time )

A test ended.

Parameters

PHPUnit_Framework_Test $test
The test that ended
float $time
The current time.

endTestSuitesource public

endTestSuite( PHPUnit_Framework_TestSuite $suite )

A test suite ended.

Parameters

PHPUnit_Framework_TestSuite $suite
The suite that ended.

paintResultsource public

paintResult( PHPUnit_Framework_TestResult $result )

Paint result

Parameters

PHPUnit_Framework_TestResult $result
The result object

printResultsource public

printResult( PHPUnit_Framework_TestResult $result )

Print result

Parameters

PHPUnit_Framework_TestResult $result
The result object

startTestsource public

startTest( PHPUnit_Framework_Test $test )

A test started.

Parameters

PHPUnit_Framework_Test $test
The test that started.

Properties inherited from CakeBaseReporter

$_characterSetsource

protected string

Character set for the output of test reporting.

$_headerSentsource

protected boolean

Headers sent

false

$paramssource

public array

Array of request parameters. Usually parsed GET params.

array()

© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/2.7/class-CakeHtmlReporter.html