SebastianBergmann\CodeCoverage\CodeCoverage Class Reference

Detailed Description

Provides collection functionality for PHP code coverage information.

Public Member Functions
	__construct (Driver $driver=null, Filter $filter=null)
	getReport ()
	clear ()
	filter ()
	getData (bool $raw=false)
	setData (array $data)
	getTests ()
	setTests (array $tests)
	start ($id, bool $clear=false)
	stop (bool $append=true, $linesToBeCovered=[], array $linesToBeUsed=[], bool $ignoreForceCoversAnnotation=false)
	append (array $data, $id=null, bool $append=true, $linesToBeCovered=[], array $linesToBeUsed=[], bool $ignoreForceCoversAnnotation=false)
	merge (self $that)
	setCacheTokens (bool $flag)
	getCacheTokens ()
	setCheckForUnintentionallyCoveredCode (bool $flag)
	setForceCoversAnnotation (bool $flag)
	setCheckForMissingCoversAnnotation (bool $flag)
	setCheckForUnexecutedCoveredCode (bool $flag)
	setAddUncoveredFilesFromWhitelist (bool $flag)
	setProcessUncoveredFilesFromWhitelist (bool $flag)
	setDisableIgnoredLines (bool $flag)
	setIgnoreDeprecatedCode (bool $flag)
	setUnintentionallyCoveredSubclassesWhitelist (array $whitelist)

Constructor & Destructor Documentation

__construct()

SebastianBergmann\CodeCoverage\CodeCoverage::__construct	(	Driver	$driver = null,
		Filter	$filter = null
	)

Exceptions

RuntimeException

Member Function Documentation

append()

SebastianBergmann\CodeCoverage\CodeCoverage::append	(	array	$data,
			$id = null,
		bool	$append = true,
			$linesToBeCovered = [],
		array	$linesToBeUsed = [],
		bool	$ignoreForceCoversAnnotation = false
	)

Appends code coverage data.

Parameters

PhptTestCase | string | TestCase	$id
array | false	$linesToBeCovered

Exceptions

clear()

SebastianBergmann\CodeCoverage\CodeCoverage::clear

(

)

Clears collected code coverage data.

filter()

SebastianBergmann\CodeCoverage\CodeCoverage::filter

(

)

Returns the filter object used.

getCacheTokens()

SebastianBergmann\CodeCoverage\CodeCoverage::getCacheTokens

(

)

getData()

SebastianBergmann\CodeCoverage\CodeCoverage::getData

(

bool

$raw = false

)

Returns the collected code coverage data.

getReport()

SebastianBergmann\CodeCoverage\CodeCoverage::getReport

(

)

Returns the code coverage information as a graph of node objects.

getTests()

SebastianBergmann\CodeCoverage\CodeCoverage::getTests

(

)

Returns the test data.

merge()

SebastianBergmann\CodeCoverage\CodeCoverage::merge

(

self

$that

)

Merges the data from another instance.

Parameters

CodeCoverage

$that

setAddUncoveredFilesFromWhitelist()

SebastianBergmann\CodeCoverage\CodeCoverage::setAddUncoveredFilesFromWhitelist

(

bool

$flag

)

setCacheTokens()

SebastianBergmann\CodeCoverage\CodeCoverage::setCacheTokens

(

bool

$flag

)

setCheckForMissingCoversAnnotation()

SebastianBergmann\CodeCoverage\CodeCoverage::setCheckForMissingCoversAnnotation

(

bool

$flag

)

setCheckForUnexecutedCoveredCode()

SebastianBergmann\CodeCoverage\CodeCoverage::setCheckForUnexecutedCoveredCode

(

bool

$flag

)

setCheckForUnintentionallyCoveredCode()

SebastianBergmann\CodeCoverage\CodeCoverage::setCheckForUnintentionallyCoveredCode

(

bool

$flag

)

setData()

SebastianBergmann\CodeCoverage\CodeCoverage::setData

(

array

$data

)

Sets the coverage data.

setDisableIgnoredLines()

SebastianBergmann\CodeCoverage\CodeCoverage::setDisableIgnoredLines

(

bool

$flag

)

setForceCoversAnnotation()

SebastianBergmann\CodeCoverage\CodeCoverage::setForceCoversAnnotation

(

bool

$flag

)

setIgnoreDeprecatedCode()

SebastianBergmann\CodeCoverage\CodeCoverage::setIgnoreDeprecatedCode

(

bool

$flag

)

setProcessUncoveredFilesFromWhitelist()

SebastianBergmann\CodeCoverage\CodeCoverage::setProcessUncoveredFilesFromWhitelist

(

bool

$flag

)

setTests()

SebastianBergmann\CodeCoverage\CodeCoverage::setTests

(

array

$tests

)

Sets the test data.

setUnintentionallyCoveredSubclassesWhitelist()

SebastianBergmann\CodeCoverage\CodeCoverage::setUnintentionallyCoveredSubclassesWhitelist

(

array

$whitelist

)

start()

SebastianBergmann\CodeCoverage\CodeCoverage::start	(		$id,
		bool	$clear = false
	)

Start collection of code coverage information.

Parameters

PhptTestCase | string | TestCase

$id

Exceptions

RuntimeException

stop()

SebastianBergmann\CodeCoverage\CodeCoverage::stop	(	bool	$append = true,
			$linesToBeCovered = [],
		array	$linesToBeUsed = [],
		bool	$ignoreForceCoversAnnotation = false
	)

Stop collection of code coverage information.

Parameters

array | false

$linesToBeCovered

Exceptions

MissingCoversAnnotationException
CoveredCodeNotExecutedException
RuntimeException
InvalidArgumentException

---

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

• vendor/phpunit/php-code-coverage/src/CodeCoverage.php