PHPUnit\Framework\TestSuite Class Reference

Inheritance diagram for PHPUnit\Framework\TestSuite:

Collaboration diagram for PHPUnit\Framework\TestSuite:

Public Member Functions
	__construct ($theClass='', $name='')
	toString ()
	addTest (Test $test, $groups=[])
	addTestSuite ($testClass)
	addTestFile ($filename)
	addTestFiles ($filenames)
	count ($preferCache=false)
	getName ()
	getGroups ()
	getGroupDetails ()
	setGroupDetails (array $groups)
	run (TestResult $result=null)
	setRunTestInSeparateProcess ($runTestInSeparateProcess)
	runTest (Test $test, TestResult $result)
	setName ($name)
	testAt ($index)
	tests ()
	setTests (array $tests)
	markTestSuiteSkipped ($message='')
	setBeStrictAboutChangesToGlobalState ($beStrictAboutChangesToGlobalState)
	setBackupGlobals ($backupGlobals)
	setBackupStaticAttributes ($backupStaticAttributes)
	getIterator ()
	injectFilter (Factory $filter)

Static Public Member Functions
static	createTest (ReflectionClass $theClass, $name)
static	isTestMethod (ReflectionMethod $method)

Protected Member Functions
	createResult ()
	addTestMethod (ReflectionClass $class, ReflectionMethod $method)
	setUp ()
	tearDown ()

Static Protected Member Functions
static	warning ($message)
static	skipTest ($class, $methodName, $message)
static	incompleteTest ($class, $methodName, $message)

Protected Attributes
	$backupGlobals
	$backupStaticAttributes
	$runTestInSeparateProcess = false
	$name = ''
	$groups = []
	$tests = []
	$numTests = -1
	$testCase = false
	$foundClasses = []

Detailed Description

A TestSuite is a composite of Tests. It runs a collection of test cases.

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\TestSuite::__construct	(		$theClass = '',
			$name = ''
	)

Constructs a new TestSuite:

• PHPUnit\Framework\TestSuite() constructs an empty TestSuite.
• PHPUnit\Framework\TestSuite(ReflectionClass) constructs a TestSuite from the given class.
• PHPUnit\Framework\TestSuite(ReflectionClass, String) constructs a TestSuite from the given class with the given name.
• PHPUnit\Framework\TestSuite(String) either constructs a TestSuite from the given class (if the passed string is the name of an existing class) or constructs an empty TestSuite with the given name.

Parameters

mixed	$theClass
string	$name

Exceptions

Exception

Member Function Documentation

addTest()

PHPUnit\Framework\TestSuite::addTest	(	Test	$test,
			$groups = []
	)

Adds a test to the suite.

Parameters

Test	$test
array	$groups

addTestFile()

PHPUnit\Framework\TestSuite::addTestFile

(

$filename

)

Wraps both addTest() and addTestSuite as well as the separate import statements for the user's convenience.

If the named file cannot be read or there are no new tests that can be added, a PHPUnit\Framework\WarningTestCase will be created instead, leaving the current test run untouched.

Parameters

string

$filename

Exceptions

Exception

addTestFiles()

PHPUnit\Framework\TestSuite::addTestFiles

(

$filenames

)

Wrapper for addTestFile() that adds multiple test files.

Parameters

array | Iterator

$filenames

Exceptions

Exception

addTestMethod()

PHPUnit\Framework\TestSuite::addTestMethod ( ReflectionClass  $class, ReflectionMethod  $method  )

protected

Parameters

ReflectionClass	$class
ReflectionMethod	$method

addTestSuite()

PHPUnit\Framework\TestSuite::addTestSuite

(

$testClass

)

Adds the tests from the given class to the suite.

Parameters

mixed

$testClass

Exceptions

Exception

count()

PHPUnit\Framework\TestSuite::count

(

$preferCache = false

)

Counts the number of test cases that will be run by this test.

Parameters

bool

$preferCache

Indicates if cache is preferred.

Returns

int

createResult()

PHPUnit\Framework\TestSuite::createResult ( )

protected

Creates a default TestResult object.

Returns

TestResult

createTest()

static PHPUnit\Framework\TestSuite::createTest ( ReflectionClass  $theClass,   $name  )

static

Parameters

ReflectionClass	$theClass
string	$name

Returns

Test

Exceptions

Exception

getGroups()

PHPUnit\Framework\TestSuite::getGroups

(

)

Returns the test groups of the suite.

Returns

array

getIterator()

PHPUnit\Framework\TestSuite::getIterator

(

)

Returns an iterator for this test suite.

Returns

TestSuiteIterator

getName()

PHPUnit\Framework\TestSuite::getName

(

)

Returns the name of the suite.

Returns

string

incompleteTest()

static PHPUnit\Framework\TestSuite::incompleteTest (   $class,   $methodName,   $message  )

staticprotected

Parameters

string	$class
string	$methodName
string	$message

Returns

IncompleteTestCase

isTestMethod()

static PHPUnit\Framework\TestSuite::isTestMethod ( ReflectionMethod  $method )

static

Parameters

ReflectionMethod

$method

Returns

bool

markTestSuiteSkipped()

PHPUnit\Framework\TestSuite::markTestSuiteSkipped

(

$message = ''

)

Mark the test suite as skipped.

Parameters

string

$message

Exceptions

SkippedTestSuiteError

run()

PHPUnit\Framework\TestSuite::run

(

TestResult

$result = null

)

Runs the tests and collects their result in a TestResult.

Parameters

TestResult

$result

Returns

TestResult

Implements PHPUnit\Framework\Test.

runTest()

PHPUnit\Framework\TestSuite::runTest	(	Test	$test,
		TestResult	$result
	)

Runs a test.

Deprecated:

Parameters

Test	$test
TestResult	$result

setBackupGlobals()

PHPUnit\Framework\TestSuite::setBackupGlobals

(

$backupGlobals

)

Parameters

bool

$backupGlobals

setBackupStaticAttributes()

PHPUnit\Framework\TestSuite::setBackupStaticAttributes

(

$backupStaticAttributes

)

Parameters

bool

$backupStaticAttributes

setBeStrictAboutChangesToGlobalState()

PHPUnit\Framework\TestSuite::setBeStrictAboutChangesToGlobalState

(

$beStrictAboutChangesToGlobalState

)

Parameters

bool

$beStrictAboutChangesToGlobalState

setGroupDetails()

PHPUnit\Framework\TestSuite::setGroupDetails

(

array

$groups

)

Set tests groups of the test case

Parameters

array

$groups

setName()

PHPUnit\Framework\TestSuite::setName

(

$name

)

Sets the name of the suite.

Parameters

string

setRunTestInSeparateProcess()

PHPUnit\Framework\TestSuite::setRunTestInSeparateProcess

(

$runTestInSeparateProcess

)

Parameters

bool

$runTestInSeparateProcess

Exceptions

Exception

setTests()

PHPUnit\Framework\TestSuite::setTests

(

array

$tests

)

Set tests of the test suite

Parameters

array

$tests

setUp()

PHPUnit\Framework\TestSuite::setUp ( )

protected

Template Method that is called before the tests of this test suite are run.

skipTest()

static PHPUnit\Framework\TestSuite::skipTest (   $class,   $methodName,   $message  )

staticprotected

Parameters

string	$class
string	$methodName
string	$message

Returns

SkippedTestCase

tearDown()

PHPUnit\Framework\TestSuite::tearDown ( )

protected

Template Method that is called after the tests of this test suite have finished running.

testAt()

PHPUnit\Framework\TestSuite::testAt

(

$index

)

Returns the test at the given index.

Parameters

int|false

Returns

Test|false

tests()

PHPUnit\Framework\TestSuite::tests

(

)

Returns the tests as an enumeration.

Returns

array

toString()

PHPUnit\Framework\TestSuite::toString

(

)

Returns a string representation of the test suite.

Returns

string

Implements PHPUnit\Framework\SelfDescribing.

warning()

static PHPUnit\Framework\TestSuite::warning (   $message )

staticprotected

Parameters

string

$message

Returns

WarningTestCase

---

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

• vendor/phpunit/phpunit/src/Framework/TestSuite.php