SebastianBergmann\CodeCoverage\Node\File Class Reference

Inheritance diagram for SebastianBergmann\CodeCoverage\Node\File:

Collaboration diagram for SebastianBergmann\CodeCoverage\Node\File:

Public Member Functions
	__construct ($name, AbstractNode $parent, array $coverageData, array $testData, $cacheTokens)
	count ()
	getCoverageData ()
	getTestData ()
	getClasses ()
	getTraits ()
	getFunctions ()
	getLinesOfCode ()
	getNumExecutableLines ()
	getNumExecutedLines ()
	getNumClasses ()
	getNumTestedClasses ()
	getNumTraits ()
	getNumTestedTraits ()
	getNumMethods ()
	getNumTestedMethods ()
	getNumFunctions ()
	getNumTestedFunctions ()
Public Member Functions inherited from SebastianBergmann\CodeCoverage\Node\AbstractNode
	__construct ($name, self $parent=null)
	getName ()
	getId ()
	getPath ()
	getPathAsArray ()
	getParent ()
	getTestedClassesPercent ($asString=true)
	getTestedTraitsPercent ($asString=true)
	getTestedClassesAndTraitsPercent ($asString=true)
	getTestedFunctionsPercent ($asString=true)
	getTestedMethodsPercent ($asString=true)
	getTestedFunctionsAndMethodsPercent ($asString=true)
	getLineExecutedPercent ($asString=true)
	getNumClassesAndTraits ()
	getNumTestedClassesAndTraits ()
	getClassesAndTraits ()
	getNumFunctionsAndMethods ()
	getNumTestedFunctionsAndMethods ()
	getFunctionsAndMethods ()

Protected Member Functions
	calculateStatistics ()
	processClasses (\PHP_Token_Stream $tokens)
	processTraits (\PHP_Token_Stream $tokens)
	processFunctions (\PHP_Token_Stream $tokens)
	crap ($ccn, $coverage)

Detailed Description

Represents a file in the code coverage information tree.

Constructor & Destructor Documentation

__construct()

SebastianBergmann\CodeCoverage\Node\File::__construct	(		$name,
		AbstractNode	$parent,
		array	$coverageData,
		array	$testData,
			$cacheTokens
	)

Constructor.

Parameters

string	$name
AbstractNode	$parent
array	$coverageData
array	$testData
bool	$cacheTokens

Exceptions

InvalidArgumentException

Member Function Documentation

calculateStatistics()

SebastianBergmann\CodeCoverage\Node\File::calculateStatistics ( )

protected

Calculates coverage statistics for the file.

count()

SebastianBergmann\CodeCoverage\Node\File::count

(

)

Returns the number of files in/under this node.

Returns

int

crap()

SebastianBergmann\CodeCoverage\Node\File::crap (   $ccn,   $coverage  )

protected

Calculates the Change Risk Anti-Patterns (CRAP) index for a unit of code based on its cyclomatic complexity and percentage of code coverage.

Parameters

int	$ccn
float	$coverage

Returns

string

getClasses()

SebastianBergmann\CodeCoverage\Node\File::getClasses

(

)

Returns the classes of this node.

Returns

array

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getCoverageData()

SebastianBergmann\CodeCoverage\Node\File::getCoverageData

(

)

Returns the code coverage data of this node.

Returns

array

getFunctions()

SebastianBergmann\CodeCoverage\Node\File::getFunctions

(

)

Returns the functions of this node.

Returns

array

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getLinesOfCode()

SebastianBergmann\CodeCoverage\Node\File::getLinesOfCode

(

)

Returns the LOC/CLOC/NCLOC of this node.

Returns

array

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumClasses()

SebastianBergmann\CodeCoverage\Node\File::getNumClasses

(

)

Returns the number of classes.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumExecutableLines()

SebastianBergmann\CodeCoverage\Node\File::getNumExecutableLines

(

)

Returns the number of executable lines.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumExecutedLines()

SebastianBergmann\CodeCoverage\Node\File::getNumExecutedLines

(

)

Returns the number of executed lines.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumFunctions()

SebastianBergmann\CodeCoverage\Node\File::getNumFunctions

(

)

Returns the number of functions.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumMethods()

SebastianBergmann\CodeCoverage\Node\File::getNumMethods

(

)

Returns the number of methods.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumTestedClasses()

SebastianBergmann\CodeCoverage\Node\File::getNumTestedClasses

(

)

Returns the number of tested classes.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumTestedFunctions()

SebastianBergmann\CodeCoverage\Node\File::getNumTestedFunctions

(

)

Returns the number of tested functions.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumTestedMethods()

SebastianBergmann\CodeCoverage\Node\File::getNumTestedMethods

(

)

Returns the number of tested methods.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumTestedTraits()

SebastianBergmann\CodeCoverage\Node\File::getNumTestedTraits

(

)

Returns the number of tested traits.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getNumTraits()

SebastianBergmann\CodeCoverage\Node\File::getNumTraits

(

)

Returns the number of traits.

Returns

int

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

getTestData()

SebastianBergmann\CodeCoverage\Node\File::getTestData

(

)

Returns the test data of this node.

Returns

array

getTraits()

SebastianBergmann\CodeCoverage\Node\File::getTraits

(

)

Returns the traits of this node.

Returns

array

Reimplemented from SebastianBergmann\CodeCoverage\Node\AbstractNode.

processClasses()

SebastianBergmann\CodeCoverage\Node\File::processClasses ( \PHP_Token_Stream  $tokens )

protected

Parameters

\PHP_Token_Stream

$tokens

processFunctions()

SebastianBergmann\CodeCoverage\Node\File::processFunctions ( \PHP_Token_Stream  $tokens )

protected

Parameters

\PHP_Token_Stream

$tokens

processTraits()

SebastianBergmann\CodeCoverage\Node\File::processTraits ( \PHP_Token_Stream  $tokens )

protected

Parameters

\PHP_Token_Stream

$tokens

---

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

• vendor/phpunit/php-code-coverage/src/Node/File.php