SebastianBergmann\CodeCoverage\Filter Class Reference

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

Detailed Description

Filter for whitelisting of code coverage information.

Member Function Documentation

addDirectoryToWhitelist()

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

Adds a directory to the whitelist (recursively).

Parameters

string	$directory
string	$suffix
string	$prefix

addFilesToWhitelist()

SebastianBergmann\CodeCoverage\Filter::addFilesToWhitelist

(

array

$files

)

Adds files to the whitelist.

Parameters

array

$files

addFileToWhitelist()

SebastianBergmann\CodeCoverage\Filter::addFileToWhitelist

(

$filename

)

Adds a file to the whitelist.

Parameters

string

$filename

getWhitelist()

SebastianBergmann\CodeCoverage\Filter::getWhitelist

(

)

Returns the list of whitelisted files.

Returns

array

getWhitelistedFiles()

SebastianBergmann\CodeCoverage\Filter::getWhitelistedFiles

(

)

Returns the whitelisted files.

Returns

array

hasWhitelist()

SebastianBergmann\CodeCoverage\Filter::hasWhitelist

(

)

Returns whether this filter has a whitelist.

Returns

bool

isFile()

SebastianBergmann\CodeCoverage\Filter::isFile

(

$filename

)

Checks whether a filename is a real filename.

Parameters

string

$filename

Returns

bool

isFiltered()

SebastianBergmann\CodeCoverage\Filter::isFiltered

(

$filename

)

Checks whether or not a file is filtered.

Parameters

string

$filename

Returns

bool

removeDirectoryFromWhitelist()

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

Removes a directory from the whitelist (recursively).

Parameters

string	$directory
string	$suffix
string	$prefix

removeFileFromWhitelist()

SebastianBergmann\CodeCoverage\Filter::removeFileFromWhitelist

(

$filename

)

Removes a file from the whitelist.

Parameters

string

$filename

setWhitelistedFiles()

SebastianBergmann\CodeCoverage\Filter::setWhitelistedFiles

(

$whitelistedFiles

)

Sets the whitelisted files.

Parameters

array

$whitelistedFiles

---

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

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