SebastianBergmann\CodeCoverage\Filter Class Reference

Detailed Description

Filter for whitelisting of code coverage information.

Public Member Functions
	addDirectoryToWhitelist (string $directory, string $suffix='.php', string $prefix='')
	addFileToWhitelist (string $filename)
	addFilesToWhitelist (array $files)
	removeDirectoryFromWhitelist (string $directory, string $suffix='.php', string $prefix='')
	removeFileFromWhitelist (string $filename)
	isFile (string $filename)
	isFiltered (string $filename)
	getWhitelist ()
	hasWhitelist ()
	getWhitelistedFiles ()
	setWhitelistedFiles (array $whitelistedFiles)

Member Function Documentation

addDirectoryToWhitelist()

SebastianBergmann\CodeCoverage\Filter::addDirectoryToWhitelist	(	string	$directory,
		string	$suffix = '.php',
		string	$prefix = ''
	)

Adds a directory to the whitelist (recursively).

addFilesToWhitelist()

SebastianBergmann\CodeCoverage\Filter::addFilesToWhitelist

(

array

$files

)

Adds files to the whitelist.

Parameters

string[]

$files

addFileToWhitelist()

SebastianBergmann\CodeCoverage\Filter::addFileToWhitelist

(

string

$filename

)

Adds a file to the whitelist.

getWhitelist()

SebastianBergmann\CodeCoverage\Filter::getWhitelist

(

)

Returns the list of whitelisted files.

Returns

string[]

getWhitelistedFiles()

SebastianBergmann\CodeCoverage\Filter::getWhitelistedFiles

(

)

Returns the whitelisted files.

Returns

string[]

hasWhitelist()

SebastianBergmann\CodeCoverage\Filter::hasWhitelist

(

)

Returns whether this filter has a whitelist.

isFile()

SebastianBergmann\CodeCoverage\Filter::isFile

(

string

$filename

)

Checks whether a filename is a real filename.

isFiltered()

SebastianBergmann\CodeCoverage\Filter::isFiltered

(

string

$filename

)

Checks whether or not a file is filtered.

removeDirectoryFromWhitelist()

SebastianBergmann\CodeCoverage\Filter::removeDirectoryFromWhitelist	(	string	$directory,
		string	$suffix = '.php',
		string	$prefix = ''
	)

Removes a directory from the whitelist (recursively).

removeFileFromWhitelist()

SebastianBergmann\CodeCoverage\Filter::removeFileFromWhitelist

(

string

$filename

)

Removes a file from the whitelist.

setWhitelistedFiles()

SebastianBergmann\CodeCoverage\Filter::setWhitelistedFiles

(

array

$whitelistedFiles

)

Sets the whitelisted files.

---

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

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