Lggr
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
PHPUnit\Util\Configuration Class Reference
Collaboration diagram for PHPUnit\Util\Configuration:
Collaboration graph
[legend]

Public Member Functions

 getFilename ()
 
 getFilterConfiguration ()
 
 getGroupConfiguration ()
 
 getTestdoxGroupConfiguration ()
 
 getListenerConfiguration ()
 
 getLoggingConfiguration ()
 
 getPHPConfiguration ()
 
 handlePHPConfiguration ()
 
 getPHPUnitConfiguration ()
 
 getTestSuiteConfiguration ($testSuiteFilter=null)
 
 getTestSuiteNames ()
 

Static Public Member Functions

static getInstance ($filename)
 

Public Attributes

const TEST_SUITE_FILTER_SEPARATOR = ','
 

Protected Member Functions

 __construct ($filename)
 
 getTestSuite (DOMElement $testSuiteNode, $testSuiteFilter=null)
 
 getBoolean ($value, $default)
 
 getInteger ($value, $default)
 
 readFilterDirectories ($query)
 
 readFilterFiles ($query)
 
 toAbsolutePath ($path, $useIncludePath=false)
 

Protected Attributes

 $document
 
 $xpath
 
 $filename
 

Detailed Description

Wrapper for the PHPUnit XML configuration file.

Example XML configuration file: <?xml version="1.0" encoding="utf-8" ?>

<phpunit backupGlobals="false" backupStaticAttributes="false" bootstrap="/path/to/bootstrap.php" cacheTokens="false" columns="80" colors="false" stderr="false" convertDeprecationsToExceptions="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" forceCoversAnnotation="false" processIsolation="false" stopOnError="false" stopOnFailure="false" stopOnWarning="false" stopOnIncomplete="false" stopOnRisky="false" stopOnSkipped="false" failOnWarning="false" failOnRisky="false" extensionsDirectory="tools/phpunit.d" printerClass="PHPUnit\TextUI\ResultPrinter" testSuiteLoaderClass="PHPUnit\Runner\StandardTestSuiteLoader" defaultTestSuite="" beStrictAboutChangesToGlobalState="false" beStrictAboutCoversAnnotation="false" beStrictAboutOutputDuringTests="false" beStrictAboutResourceUsageDuringSmallTests="false" beStrictAboutTestsThatDoNotTestAnything="false" beStrictAboutTodoAnnotatedTests="false" enforceTimeLimit="false" ignoreDeprecatedCodeUnitsFromCodeCoverage="false" timeoutForSmallTests="1" timeoutForMediumTests="10" timeoutForLargeTests="60" verbose="false" reverseDefectList="false" registerMockObjectsFromTestArgumentsRecursively="false"> <testsuites> <testsuite name="My Test Suite"> <directory suffix="Test.php" phpVersion="5.3.0" phpVersionOperator=">=">/path/to/files</directory> <file phpVersion="5.3.0" phpVersionOperator=">=">/path/to/MyTest.php</file> <exclude>/path/to/files/exclude</exclude> </testsuite> </testsuites>

<groups> <group>name</group> <exclude> <group>name</group> </exclude> </groups>

<testdoxGroups> <group>name</group> <exclude> <group>name</group> </exclude> </testdoxGroups>

<filter> <whitelist addUncoveredFilesFromWhitelist="true" processUncoveredFilesFromWhitelist="false"> <directory suffix=".php">/path/to/files</directory> <file>/path/to/file</file> <exclude> <directory suffix=".php">/path/to/files</directory> <file>/path/to/file</file> </exclude> </whitelist> </filter>

<listeners> <listener class="MyListener" file="/optional/path/to/MyListener.php"> <arguments> <array> <element key="0"> <string>Sebastian</string> </element> </array> <integer>22</integer> <string>April</string> <double>19.78</double> <null> <object class="stdClass"> <file>MyRelativeFile.php</file> <directory>MyRelativeDir</directory> </arguments> </listener> </listeners>

<logging> <log type="coverage-html" target="/tmp/report" lowUpperBound="50" highLowerBound="90"> <log type="coverage-clover" target="/tmp/clover.xml"> <log type="coverage-crap4j" target="/tmp/crap.xml" threshold="30"> <log type="json" target="/tmp/logfile.json"> <log type="plain" target="/tmp/logfile.txt"> <log type="teamcity" target="/tmp/logfile.txt"> <log type="junit" target="/tmp/logfile.xml"> <log type="testdox-html" target="/tmp/testdox.html"> <log type="testdox-text" target="/tmp/testdox.txt"> <log type="testdox-xml" target="/tmp/testdox.xml"> </logging>

<php> <includePath>.</includePath> <ini name="foo" value="bar"> <const name="foo" value="bar"> <env name="foo" value="bar"> <post name="foo" value="bar"> <get name="foo" value="bar"> <cookie name="foo" value="bar"> <server name="foo" value="bar"> <files name="foo" value="bar"> <request name="foo" value="bar"> </php> </phpunit>

Constructor & Destructor Documentation

◆ __construct()

PHPUnit\Util\Configuration::__construct (   $filename)
protected

Loads a PHPUnit configuration file.

Parameters
string$filename

Member Function Documentation

◆ getBoolean()

PHPUnit\Util\Configuration::getBoolean (   $value,
  $default 
)
protected

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
Returns
string|bool

◆ getFilename()

PHPUnit\Util\Configuration::getFilename ( )

Returns the realpath to the configuration file.

Returns
string

◆ getFilterConfiguration()

PHPUnit\Util\Configuration::getFilterConfiguration ( )

Returns the configuration for SUT filtering.

Returns
array

◆ getGroupConfiguration()

PHPUnit\Util\Configuration::getGroupConfiguration ( )

Returns the configuration for groups.

Returns
array

◆ getInstance()

static PHPUnit\Util\Configuration::getInstance (   $filename)
static

Returns a PHPUnit configuration object.

Parameters
string$filename
Returns
Configuration

◆ getInteger()

PHPUnit\Util\Configuration::getInteger (   $value,
  $default 
)
protected
Parameters
string$value
int$default
Returns
int

◆ getListenerConfiguration()

PHPUnit\Util\Configuration::getListenerConfiguration ( )

Returns the configuration for listeners.

Returns
array

◆ getLoggingConfiguration()

PHPUnit\Util\Configuration::getLoggingConfiguration ( )

Returns the logging configuration.

Returns
array

◆ getPHPConfiguration()

PHPUnit\Util\Configuration::getPHPConfiguration ( )

Returns the PHP configuration.

Returns
array

◆ getPHPUnitConfiguration()

PHPUnit\Util\Configuration::getPHPUnitConfiguration ( )

Returns the PHPUnit configuration.

Returns
array

◆ getTestdoxGroupConfiguration()

PHPUnit\Util\Configuration::getTestdoxGroupConfiguration ( )

Returns the configuration for testdox groups.

Returns
array

◆ getTestSuite()

PHPUnit\Util\Configuration::getTestSuite ( DOMElement  $testSuiteNode,
  $testSuiteFilter = null 
)
protected
Parameters
DOMElement$testSuiteNode
string | null$testSuiteFilter
Returns
TestSuite

◆ getTestSuiteConfiguration()

PHPUnit\Util\Configuration::getTestSuiteConfiguration (   $testSuiteFilter = null)

Returns the test suite configuration.

Parameters
string | null$testSuiteFilter
Returns
TestSuite

◆ getTestSuiteNames()

PHPUnit\Util\Configuration::getTestSuiteNames ( )

Returns the test suite names from the configuration.

Returns
array

◆ handlePHPConfiguration()

PHPUnit\Util\Configuration::handlePHPConfiguration ( )

Handles the PHP configuration.

◆ readFilterDirectories()

PHPUnit\Util\Configuration::readFilterDirectories (   $query)
protected
Parameters
string$query
Returns
array

◆ readFilterFiles()

PHPUnit\Util\Configuration::readFilterFiles (   $query)
protected
Parameters
string$query
Returns
array

◆ toAbsolutePath()

PHPUnit\Util\Configuration::toAbsolutePath (   $path,
  $useIncludePath = false 
)
protected
Parameters
string$path
bool$useIncludePath
Returns
string
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17