PHPUnit\Framework\TestResult Class Reference

Inheritance diagram for PHPUnit\Framework\TestResult:

Collaboration diagram for PHPUnit\Framework\TestResult:

Public Member Functions
	addListener (TestListener $listener)
	removeListener (TestListener $listener)
	flushListeners ()
	addError (Test $test, Throwable $t, $time)
	addWarning (Test $test, Warning $e, $time)
	addFailure (Test $test, AssertionFailedError $e, $time)
	startTestSuite (TestSuite $suite)
	endTestSuite (TestSuite $suite)
	startTest (Test $test)
	endTest (Test $test, $time)
	allHarmless ()
	riskyCount ()
	allCompletelyImplemented ()
	notImplementedCount ()
	risky ()
	notImplemented ()
	noneSkipped ()
	skippedCount ()
	skipped ()
	errorCount ()
	errors ()
	failureCount ()
	failures ()
	warningCount ()
	warnings ()
	passed ()
	topTestSuite ()
	getCollectCodeCoverageInformation ()
	run (Test $test)
	count ()
	shouldStop ()
	stop ()
	getCodeCoverage ()
	setCodeCoverage (CodeCoverage $codeCoverage)
	convertErrorsToExceptions ($flag)
	getConvertErrorsToExceptions ()
	stopOnError ($flag)
	stopOnFailure ($flag)
	stopOnWarning ($flag)
	beStrictAboutTestsThatDoNotTestAnything ($flag)
	isStrictAboutTestsThatDoNotTestAnything ()
	beStrictAboutOutputDuringTests ($flag)
	isStrictAboutOutputDuringTests ()
	beStrictAboutResourceUsageDuringSmallTests ($flag)
	isStrictAboutResourceUsageDuringSmallTests ()
	enforceTimeLimit ($flag)
	enforcesTimeLimit ()
	beStrictAboutTodoAnnotatedTests ($flag)
	isStrictAboutTodoAnnotatedTests ()
	stopOnRisky ($flag)
	stopOnIncomplete ($flag)
	stopOnSkipped ($flag)
	time ()
	wasSuccessful ()
	setTimeoutForSmallTests ($timeout)
	setTimeoutForMediumTests ($timeout)
	setTimeoutForLargeTests ($timeout)
	getTimeoutForLargeTests ()
	setRegisterMockObjectsFromTestArgumentsRecursively ($flag)

Protected Member Functions
	getHierarchy ($className, $asReflectionObjects=false)

Protected Attributes
	$passed = []
	$errors = []
	$failures = []
	$warnings = []
	$notImplemented = []
	$risky = []
	$skipped = []
	$listeners = []
	$runTests = 0
	$time = 0
	$topTestSuite
	$codeCoverage
	$convertErrorsToExceptions = true
	$stop = false
	$stopOnError = false
	$stopOnFailure = false
	$stopOnWarning = false
	$beStrictAboutTestsThatDoNotTestAnything = true
	$beStrictAboutOutputDuringTests = false
	$beStrictAboutTodoAnnotatedTests = false
	$beStrictAboutResourceUsageDuringSmallTests = false
	$enforceTimeLimit = false
	$timeoutForSmallTests = 1
	$timeoutForMediumTests = 10
	$timeoutForLargeTests = 60
	$stopOnRisky = false
	$stopOnIncomplete = false
	$stopOnSkipped = false
	$lastTestFailed = false

Detailed Description

A TestResult collects the results of executing a test case.

Member Function Documentation

addError()

PHPUnit\Framework\TestResult::addError	(	Test	$test,
		Throwable	$t,
			$time
	)

Adds an error to the list of errors.

Parameters

Test	$test
Throwable	$t
float	$time

addFailure()

PHPUnit\Framework\TestResult::addFailure	(	Test	$test,
		AssertionFailedError	$e,
			$time
	)

Adds a failure to the list of failures. The passed in exception caused the failure.

Parameters

Test	$test
AssertionFailedError	$e
float	$time

addListener()

PHPUnit\Framework\TestResult::addListener

(

TestListener

$listener

)

Registers a TestListener.

Parameters

TestListener

$listener

addWarning()

PHPUnit\Framework\TestResult::addWarning	(	Test	$test,
		Warning	$e,
			$time
	)

Adds a warning to the list of warnings. The passed in exception caused the warning.

Parameters

Test	$test
Warning	$e
float	$time

allCompletelyImplemented()

PHPUnit\Framework\TestResult::allCompletelyImplemented

(

)

Returns true if no incomplete test occurred.

Returns

bool

allHarmless()

PHPUnit\Framework\TestResult::allHarmless

(

)

Returns true if no risky test occurred.

Returns

bool

beStrictAboutOutputDuringTests()

PHPUnit\Framework\TestResult::beStrictAboutOutputDuringTests

(

$flag

)

Parameters

bool

$flag

Exceptions

Exception

beStrictAboutResourceUsageDuringSmallTests()

PHPUnit\Framework\TestResult::beStrictAboutResourceUsageDuringSmallTests

(

$flag

)

Parameters

bool

$flag

Exceptions

Exception

beStrictAboutTestsThatDoNotTestAnything()

PHPUnit\Framework\TestResult::beStrictAboutTestsThatDoNotTestAnything

(

$flag

)

Parameters

bool

$flag

Exceptions

Exception

beStrictAboutTodoAnnotatedTests()

PHPUnit\Framework\TestResult::beStrictAboutTodoAnnotatedTests

(

$flag

)

Parameters

bool

$flag

Exceptions

Exception

convertErrorsToExceptions()

PHPUnit\Framework\TestResult::convertErrorsToExceptions

(

$flag

)

Enables or disables the error-to-exception conversion.

Parameters

bool

$flag

Exceptions

Exception

count()

PHPUnit\Framework\TestResult::count

(

)

Gets the number of run tests.

Returns

int

endTest()

PHPUnit\Framework\TestResult::endTest	(	Test	$test,
			$time
	)

Informs the result that a test was completed.

Parameters

Test	$test
float	$time

endTestSuite()

PHPUnit\Framework\TestResult::endTestSuite

(

TestSuite

$suite

)

Informs the result that a testsuite was completed.

Parameters

TestSuite

$suite

enforcesTimeLimit()

PHPUnit\Framework\TestResult::enforcesTimeLimit

(

)

Returns

bool

enforceTimeLimit()

PHPUnit\Framework\TestResult::enforceTimeLimit

(

$flag

)

Parameters

bool

$flag

Exceptions

Exception

errorCount()

PHPUnit\Framework\TestResult::errorCount

(

)

Gets the number of detected errors.

Returns

int

errors()

PHPUnit\Framework\TestResult::errors

(

)

Returns an Enumeration for the errors.

Returns

array

failureCount()

PHPUnit\Framework\TestResult::failureCount

(

)

Gets the number of detected failures.

Returns

int

failures()

PHPUnit\Framework\TestResult::failures

(

)

Returns an Enumeration for the failures.

Returns

array

flushListeners()

PHPUnit\Framework\TestResult::flushListeners

(

)

Flushes all flushable TestListeners.

getCodeCoverage()

PHPUnit\Framework\TestResult::getCodeCoverage

(

)

Returns the code coverage object.

Returns

CodeCoverage

getCollectCodeCoverageInformation()

PHPUnit\Framework\TestResult::getCollectCodeCoverageInformation

(

)

Returns whether code coverage information should be collected.

Returns

bool If code coverage should be collected

getConvertErrorsToExceptions()

PHPUnit\Framework\TestResult::getConvertErrorsToExceptions

(

)

Returns the error-to-exception conversion setting.

Returns

bool

getHierarchy()

PHPUnit\Framework\TestResult::getHierarchy (   $className,   $asReflectionObjects = false  )

protected

Returns the class hierarchy for a given class.

Parameters

string	$className
bool	$asReflectionObjects

Returns

array

getTimeoutForLargeTests()

PHPUnit\Framework\TestResult::getTimeoutForLargeTests

(

)

Returns the set timeout for large tests.

Returns

int

isStrictAboutOutputDuringTests()

PHPUnit\Framework\TestResult::isStrictAboutOutputDuringTests

(

)

Returns

bool

isStrictAboutResourceUsageDuringSmallTests()

PHPUnit\Framework\TestResult::isStrictAboutResourceUsageDuringSmallTests

(

)

Returns

bool

isStrictAboutTestsThatDoNotTestAnything()

PHPUnit\Framework\TestResult::isStrictAboutTestsThatDoNotTestAnything

(

)

Returns

bool

isStrictAboutTodoAnnotatedTests()

PHPUnit\Framework\TestResult::isStrictAboutTodoAnnotatedTests

(

)

Returns

bool

noneSkipped()

PHPUnit\Framework\TestResult::noneSkipped

(

)

Returns true if no test has been skipped.

Returns

bool

notImplemented()

PHPUnit\Framework\TestResult::notImplemented

(

)

Returns an Enumeration for the incomplete tests.

Returns

array

notImplementedCount()

PHPUnit\Framework\TestResult::notImplementedCount

(

)

Gets the number of incomplete tests.

Returns

int

passed()

PHPUnit\Framework\TestResult::passed

(

)

Returns the names of the tests that have passed.

Returns

array

removeListener()

PHPUnit\Framework\TestResult::removeListener

(

TestListener

$listener

)

Unregisters a TestListener.

Parameters

TestListener

$listener

risky()

PHPUnit\Framework\TestResult::risky

(

)

Returns an Enumeration for the risky tests.

Returns

array

riskyCount()

PHPUnit\Framework\TestResult::riskyCount

(

)

Gets the number of risky tests.

Returns

int

run()

PHPUnit\Framework\TestResult::run

(

Test

$test

)

Runs a TestCase.

Parameters

Test

$test

setCodeCoverage()

PHPUnit\Framework\TestResult::setCodeCoverage

(

CodeCoverage

$codeCoverage

)

Sets the code coverage object.

Parameters

CodeCoverage

$codeCoverage

setRegisterMockObjectsFromTestArgumentsRecursively()

PHPUnit\Framework\TestResult::setRegisterMockObjectsFromTestArgumentsRecursively

(

$flag

)

Parameters

bool

$flag

setTimeoutForLargeTests()

PHPUnit\Framework\TestResult::setTimeoutForLargeTests

(

$timeout

)

Sets the timeout for large tests.

Parameters

int

$timeout

Exceptions

Exception

setTimeoutForMediumTests()

PHPUnit\Framework\TestResult::setTimeoutForMediumTests

(

$timeout

)

Sets the timeout for medium tests.

Parameters

int

$timeout

Exceptions

Exception

setTimeoutForSmallTests()

PHPUnit\Framework\TestResult::setTimeoutForSmallTests

(

$timeout

)

Sets the timeout for small tests.

Parameters

int

$timeout

Exceptions

Exception

shouldStop()

PHPUnit\Framework\TestResult::shouldStop

(

)

Checks whether the test run should stop.

Returns

bool

skipped()

PHPUnit\Framework\TestResult::skipped

(

)

Returns an Enumeration for the skipped tests.

Returns

array

skippedCount()

PHPUnit\Framework\TestResult::skippedCount

(

)

Gets the number of skipped tests.

Returns

int

startTest()

PHPUnit\Framework\TestResult::startTest

(

Test

$test

)

Informs the result that a test will be started.

Parameters

Test

$test

startTestSuite()

PHPUnit\Framework\TestResult::startTestSuite

(

TestSuite

$suite

)

Informs the result that a testsuite will be started.

Parameters

TestSuite

$suite

stop()

PHPUnit\Framework\TestResult::stop

(

)

Marks that the test run should stop.

stopOnError()

PHPUnit\Framework\TestResult::stopOnError

(

$flag

)

Enables or disables the stopping when an error occurs.

Parameters

bool

$flag

Exceptions

Exception

stopOnFailure()

PHPUnit\Framework\TestResult::stopOnFailure

(

$flag

)

Enables or disables the stopping when a failure occurs.

Parameters

bool

$flag

Exceptions

Exception

stopOnIncomplete()

PHPUnit\Framework\TestResult::stopOnIncomplete

(

$flag

)

Enables or disables the stopping for incomplete tests.

Parameters

bool

$flag

Exceptions

Exception

stopOnRisky()

PHPUnit\Framework\TestResult::stopOnRisky

(

$flag

)

Enables or disables the stopping for risky tests.

Parameters

bool

$flag

Exceptions

Exception

stopOnSkipped()

PHPUnit\Framework\TestResult::stopOnSkipped

(

$flag

)

Enables or disables the stopping for skipped tests.

Parameters

bool

$flag

Exceptions

Exception

stopOnWarning()

PHPUnit\Framework\TestResult::stopOnWarning

(

$flag

)

Enables or disables the stopping when a warning occurs.

Parameters

bool

$flag

Exceptions

Exception

time()

PHPUnit\Framework\TestResult::time

(

)

Returns the time spent running the tests.

Returns

float

topTestSuite()

PHPUnit\Framework\TestResult::topTestSuite

(

)

Returns the (top) test suite.

Returns

TestSuite

warningCount()

PHPUnit\Framework\TestResult::warningCount

(

)

Gets the number of detected warnings.

Returns

int

warnings()

PHPUnit\Framework\TestResult::warnings

(

)

Returns an Enumeration for the warnings.

Returns

array

wasSuccessful()

PHPUnit\Framework\TestResult::wasSuccessful

(

)

Returns whether the entire test was successful or not.

Returns

bool

---

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

• vendor/phpunit/phpunit/src/Framework/TestResult.php