1. class
  2. PHPUnit
  3. \
  4. Util
  5. \
  6. Configuration

Configuration

class Configuration (View source)

Wrapper for the PHPUnit XML configuration file.

Example XML configuration file:

/path/to/files /path/to/MyTest.php /path/to/files/exclude

name name

name name

/path/to/files /path/to/file /path/to/files /path/to/file

Sebastian 22 April 19.78 MyRelativeFile.php MyRelativeDir

.

Constants

TEST_SUITE_FILTER_SEPARATOR

Properties

protected $document
protected $xpath
protected $filename

Methods

__construct(string $filename)

Loads a PHPUnit configuration file.

static Configuration
getInstance(string $filename)

Returns a PHPUnit configuration object.

string
getFilename()

Returns the realpath to the configuration file.

array
getFilterConfiguration()

Returns the configuration for SUT filtering.

array
getGroupConfiguration()

Returns the configuration for groups.

array
getTestdoxGroupConfiguration()

Returns the configuration for testdox groups.

array
getListenerConfiguration()

Returns the configuration for listeners.

array
getLoggingConfiguration()

Returns the logging configuration.

array
getPHPConfiguration()

Returns the PHP configuration.

handlePHPConfiguration()

Handles the PHP configuration.

array
getPHPUnitConfiguration()

Returns the PHPUnit configuration.

TestSuite
getTestSuiteConfiguration(string|null $testSuiteFilter = null)

Returns the test suite configuration.

array
getTestSuiteNames()

Returns the test suite names from the configuration.

TestSuite
getTestSuite(DOMElement $testSuiteNode, string|null $testSuiteFilter = null)

No description

string|bool
getBoolean(string $value, string|bool $default)

if $value is 'false' or 'true', this returns the value that $value represents.

int
getInteger(string $value, int $default)

No description

array
readFilterDirectories(string $query)

No description

array
readFilterFiles(string $query)

No description

string
toAbsolutePath(string $path, bool $useIncludePath = false)

No description

Details

at line 166
protected __construct(string $filename)

Loads a PHPUnit configuration file.

Parameters

string $filename

at line 184
static Configuration getInstance(string $filename)

Returns a PHPUnit configuration object.

Parameters

string $filename

Return Value

Configuration

at line 209
string getFilename()

Returns the realpath to the configuration file.

Return Value

string

at line 219
array getFilterConfiguration()

Returns the configuration for SUT filtering.

Return Value

array

at line 281
array getGroupConfiguration()

Returns the configuration for groups.

Return Value

array

at line 291
array getTestdoxGroupConfiguration()

Returns the configuration for testdox groups.

Return Value

array

at line 324
array getListenerConfiguration()

Returns the configuration for listeners.

Return Value

array

at line 369
array getLoggingConfiguration()

Returns the logging configuration.

Return Value

array

at line 430
array getPHPConfiguration()

Returns the PHP configuration.

Return Value

array

at line 499
handlePHPConfiguration()

Handles the PHP configuration.

at line 574
array getPHPUnitConfiguration()

Returns the PHPUnit configuration.

Return Value

array

at line 887
TestSuite getTestSuiteConfiguration(string|null $testSuiteFilter = null)

Returns the test suite configuration.

Parameters

string|null $testSuiteFilter

Return Value

TestSuite

at line 916
array getTestSuiteNames()

Returns the test suite names from the configuration.

Return Value

array

at line 933
protected TestSuite getTestSuite(DOMElement $testSuiteNode, string|null $testSuiteFilter = null)

Parameters

DOMElement $testSuiteNode
string|null $testSuiteFilter

Return Value

TestSuite

at line 1057
protected string|bool getBoolean(string $value, string|bool $default)

if $value is 'false' or 'true', this returns the value that $value represents.

Otherwise, returns $default, which may be a string in rare cases. See PHPUnit\Util\ConfigurationTest::testPHPConfigurationIsReadCorrectly

Parameters

string $value
string|bool $default

Return Value

string|bool

at line 1076
protected int getInteger(string $value, int $default)

Parameters

string $value
int $default

Return Value

int

at line 1090
protected array readFilterDirectories(string $query)

Parameters

string $query

Return Value

array

at line 1135
protected array readFilterFiles(string $query)

Parameters

string $query

Return Value

array

at line 1156
protected string toAbsolutePath(string $path, bool $useIncludePath = false)

Parameters

string $path
bool $useIncludePath

Return Value

string