PHPUnit\Framework\TestCase Class Reference

Inherits PHPUnit\Framework\Assert, PHPUnit\Framework\Test, and PHPUnit\Framework\SelfDescribing.

Inherited by AbstractTest, AdminConfigTest, AssertionExampleTest, BankAccountTest, BankAccountWithCustomExtensionTest, BeforeAndAfterTest, BeforeClassAndAfterClassTest, BeforeClassWithOnlyDataProviderTest, ChangeCurrentWorkingDirectoryTest, ClonedDependencyTest, ConfigTest, ConsecutiveParametersTest, CoverageClassExtendedTest, CoverageClassTest, CoverageFunctionParenthesesTest, CoverageFunctionParenthesesWhitespaceTest, CoverageFunctionTest, CoverageMethodOneLineAnnotationTest, CoverageMethodParenthesesTest, CoverageMethodParenthesesWhitespaceTest, CoverageMethodTest, CoverageNamespacedFunctionTest, CoverageNoneTest, CoverageNothingTest, CoverageNotPrivateTest, CoverageNotProtectedTest, CoverageNotPublicTest, CoveragePrivateTest, CoverageProtectedTest, CoveragePublicTest, DataProviderDebugTest, DataProviderDependencyTest, DataProviderFilterTest, DataProviderIncompleteTest, DataProviderSkippedTest, DataProviderTest, DataProviderTestDoxTest, DependencyFailureTest, DependencySuccessTest, DummyBarTest, DummyFooTest, EmptyTestCaseTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTearDownTest, ExceptionInTest, ExceptionStackTest, ExceptionTest, Failure, FailureTest, FatalTest, Foo\DataProviderIssue2833\FirstTest, Foo\DataProviderIssue2833\SecondTest, Foo\DataProviderIssue2859\TestWithDataProviderTest, Foo\DataProviderIssue2922\FirstTest, Foo\DataProviderIssue2922\SecondHelloWorldTest, Foo_Bar_Issue684Test, Framework\Constraint\LogicalXorTest, GeneratorTest, GenericDbTestCase, IgnoreCodeCoverageClassTest, IncompleteTest, InheritanceB, IniTest, InvocationMockerTest, IsolationTest, Issue1021Test, Issue1149Test, Issue1216Test, Issue1265Test, Issue1330Test, Issue1335Test, Issue1337Test, Issue1348Test, Issue1351Test, Issue1374Test, Issue1437Test, Issue1468Test, Issue1471Test, Issue1472Test, Issue1570Test, Issue2137Test, Issue2145Test, Issue2158Test, Issue2366Test, Issue2380Test, Issue2382Test, Issue2435Test, Issue244Test, Issue2591_SeparateClassPreserveTest, Issue2591_SeparateFunctionNoPreserveTest, Issue2591_SeparateFunctionPreserveTest, Issue2725\BeforeAfterClassPidTest, Issue2731Test, Issue2811Test, Issue2830Test, Issue2972\Issue2972Test, Issue322Test, Issue433Test, Issue445Test, Issue498Test, Issue503Test, Issue523Test, Issue578Test, Issue581Test, Issue74Test, Issue765Test, Issue797Test, MockBuilderTest, MockObjectTest, MultiDependencyTest, MultipleDataProviderTest, My\Space\ExceptionNamespaceTest, NamespaceCoverageClassExtendedTest, NamespaceCoverageClassTest, NamespaceCoverageCoversClassPublicTest, NamespaceCoverageCoversClassTest, NamespaceCoverageMethodTest, NamespaceCoverageNotPrivateTest, NamespaceCoverageNotProtectedTest, NamespaceCoverageNotPublicTest, NamespaceCoveragePrivateTest, NamespaceCoverageProtectedTest, NamespaceCoveragePublicTest, NoArgTestCaseTest, NoTestCases, NotExistingCoveredElementTest, NothingTest, NotPublicTestCase, NotVoidTestCase, ObjectInvocationTest, OneTest, OneTestCase, OutputTestCase, PharIo\Manifest\ApplicationNameTest, PharIo\Manifest\ApplicationTest, PharIo\Manifest\AuthorCollectionTest, PharIo\Manifest\AuthorTest, PharIo\Manifest\BundledComponentCollectionTest, PharIo\Manifest\BundledComponentTest, PharIo\Manifest\CopyrightInformationTest, PharIo\Manifest\EmailTest, PharIo\Manifest\ExtensionTest, PharIo\Manifest\LibraryTest, PharIo\Manifest\LicenseTest, PharIo\Manifest\ManifestTest, PharIo\Manifest\PhpExtensionRequirementTest, PharIo\Manifest\PhpVersionRequirementTest, PharIo\Manifest\RequirementCollectionTest, PharIo\Manifest\UrlTest, PharIo\Version\AbstractVersionConstraintTest, PharIo\Version\AndVersionConstraintGroupTest, PharIo\Version\AnyVersionConstraintTest, PharIo\Version\ExactVersionConstraintTest, PharIo\Version\GreaterThanOrEqualToVersionConstraintTest, PharIo\Version\OrVersionConstraintGroupTest, PharIo\Version\SpecificMajorAndMinorVersionConstraintTest, PharIo\Version\SpecificMajorVersionConstraintTest, PharIo\Version\VersionConstraintParserTest, PharIo\Version\VersionTest, PHP_TimerTest, PHP_Token_ClassTest, PHP_Token_ClosureTest, PHP_Token_FunctionTest, PHP_Token_IncludeTest, PHP_Token_InterfaceTest, PHP_Token_NamespaceTest, PHP_TokenTest, PHPUnit\Framework\AssertTest, PHPUnit\Framework\BaseTestListenerTest, PHPUnit\Framework\Constraint\ConstraintTestCase, PHPUnit\Framework\Constraint\ExceptionMessageRegExpTest, PHPUnit\Framework\Constraint\ExceptionMessageTest, PHPUnit\Framework\Constraint\JsonMatchesErrorMessageProviderTest, PHPUnit\Framework\ConstraintTest, PHPUnit\Framework\IncompleteTestCase, PHPUnit\Framework\SkippedTestCase, PHPUnit\Framework\SuiteTest, PHPUnit\Framework\TestCaseTest, PHPUnit\Framework\TestFailureTest, PHPUnit\Framework\TestImplementorTest, PHPUnit\Framework\TestListenerTest, PHPUnit\Framework\WarningTestCase, PHPUnit\Runner\Filter\NameFilterIteratorTest, PHPUnit\Runner\PhptTestCaseTest, PHPUnit\TextUI\TestRunnerTest, PHPUnit\Util\ConfigurationGeneratorTest, PHPUnit\Util\ConfigurationTest, PHPUnit\Util\GetoptTest, PHPUnit\Util\GlobalStateTest, PHPUnit\Util\JsonTest, PHPUnit\Util\PHP\AbstractPhpProcessTest, PHPUnit\Util\RegularExpressionTest, PHPUnit\Util\TestDox\NamePrettifierTest, PHPUnit\Util\TestTest, PHPUnit\Util\XmlTest, ProxyObjectTest, RequirementsClassBeforeClassHookTest, RequirementsTest, SebastianBergmann\CodeCoverage\TestCase, SebastianBergmann\CodeUnitReverseLookup\WizardTest, SebastianBergmann\Comparator\ArrayComparatorTest, SebastianBergmann\Comparator\ComparisonFailureTest, SebastianBergmann\Comparator\DateTimeComparatorTest, SebastianBergmann\Comparator\DOMNodeComparatorTest, SebastianBergmann\Comparator\DoubleComparatorTest, SebastianBergmann\Comparator\ExceptionComparatorTest, SebastianBergmann\Comparator\FactoryTest, SebastianBergmann\Comparator\MockObjectComparatorTest, SebastianBergmann\Comparator\NumericComparatorTest, SebastianBergmann\Comparator\ObjectComparatorTest, SebastianBergmann\Comparator\ResourceComparatorTest, SebastianBergmann\Comparator\ScalarComparatorTest, SebastianBergmann\Comparator\SplObjectStorageComparatorTest, SebastianBergmann\Comparator\TypeComparatorTest, SebastianBergmann\Diff\ChunkTest, SebastianBergmann\Diff\DifferTestTest, SebastianBergmann\Diff\DiffTest, SebastianBergmann\Diff\LineTest, SebastianBergmann\Diff\LongestCommonSubsequenceTest, SebastianBergmann\Diff\ParserTest, SebastianBergmann\Environment\ConsoleTest, SebastianBergmann\Environment\OperatingSystemTest, SebastianBergmann\Environment\RuntimeTest, SebastianBergmann\Exporter\ExporterTest, SebastianBergmann\GlobalState\BlacklistTest, SebastianBergmann\GlobalState\CodeExporterTest, SebastianBergmann\GlobalState\RestorerTest, SebastianBergmann\GlobalState\SnapshotTest, SebastianBergmann\ObjectEnumerator\EnumeratorTest, SebastianBergmann\ObjectReflector\ObjectReflectorTest, SebastianBergmann\RecursionContext\ContextTest, StackTest, StaticInvocationTest, StopsOnWarningTest, Success, TemplateMethodsTest, TestAutoreferenced, TestDoxGroupTest, TestError, TestIncomplete, TestSkipped, TestWithTest, ThrowExceptionTestCase, ThrowNoExceptionTestCase, TwoTest, vendor\project\StatusTest, and WasRun.

Collaboration diagram for PHPUnit\Framework\TestCase:

Public Member Functions
	__construct ($name=null, array $data=[], $dataName='')
	toString ()
	count ()
	getGroups ()
	setGroups (array $groups)
	getAnnotations ()
	getName ($withDataSet=true)
	getSize ()
	hasSize ()
	isSmall ()
	isMedium ()
	isLarge ()
	getActualOutput ()
	hasOutput ()
	doesNotPerformAssertions ()
	expectOutputRegex ($expectedRegex)
	expectOutputString ($expectedString)
	hasExpectationOnOutput ()
	getExpectedException ()
	getExpectedExceptionCode ()
	getExpectedExceptionMessage ()
	getExpectedExceptionMessageRegExp ()
	expectException ($exception)
	expectExceptionCode ($code)
	expectExceptionMessage ($message)
	expectExceptionMessageRegExp ($messageRegExp)
	expectExceptionObject (\Exception $exception)
	setRegisterMockObjectsFromTestArgumentsRecursively ($flag)
	setUseErrorHandler ($useErrorHandler)
	getStatus ()
	markAsRisky ()
	getStatusMessage ()
	hasFailed ()
	run (TestResult $result=null)
	runBare ()
	setName ($name)
	setDependencies (array $dependencies)
	hasDependencies ()
	setDependencyInput (array $dependencyInput)
	setBeStrictAboutChangesToGlobalState ($beStrictAboutChangesToGlobalState)
	setBackupGlobals ($backupGlobals)
	setBackupStaticAttributes ($backupStaticAttributes)
	setRunTestInSeparateProcess ($runTestInSeparateProcess)
	setRunClassInSeparateProcess ($runClassInSeparateProcess)
	setPreserveGlobalState ($preserveGlobalState)
	setInIsolation ($inIsolation)
	isInIsolation ()
	getResult ()
	setResult ($result)
	setOutputCallback ($callback)
	getTestResultObject ()
	setTestResultObject (TestResult $result)
	registerMockObject (MockObject $mockObject)
	getMockBuilder ($className)
	addToAssertionCount ($count)
	getNumAssertions ()
	usesDataProvider ()
	dataDescription ()
	dataName ()
	registerComparator (Comparator $comparator)
	getDataSetAsString ($includeData=true)

Static Public Member Functions
static	any ()
static	never ()
static	atLeast ($requiredInvocations)
static	atLeastOnce ()
static	once ()
static	exactly ($count)
static	atMost ($allowedInvocations)
static	at ($index)
static	returnValue ($value)
static	returnValueMap (array $valueMap)
static	returnArgument ($argumentIndex)
static	returnCallback ($callback)
static	returnSelf ()
static	throwException (Throwable $exception)
static	onConsecutiveCalls ()
static	setUpBeforeClass ()
static	tearDownAfterClass ()
Static Public Member Functions inherited from PHPUnit\Framework\Assert
static	assertArrayHasKey ($key, $array, $message='')
static	assertArraySubset ($subset, $array, $strict=false, $message='')
static	assertArrayNotHasKey ($key, $array, $message='')
static	assertContains ($needle, $haystack, $message='', $ignoreCase=false, $checkForObjectIdentity=true, $checkForNonObjectIdentity=false)
static	assertAttributeContains ($needle, $haystackAttributeName, $haystackClassOrObject, $message='', $ignoreCase=false, $checkForObjectIdentity=true, $checkForNonObjectIdentity=false)
static	assertNotContains ($needle, $haystack, $message='', $ignoreCase=false, $checkForObjectIdentity=true, $checkForNonObjectIdentity=false)
static	assertAttributeNotContains ($needle, $haystackAttributeName, $haystackClassOrObject, $message='', $ignoreCase=false, $checkForObjectIdentity=true, $checkForNonObjectIdentity=false)
static	assertContainsOnly ($type, $haystack, $isNativeType=null, $message='')
static	assertContainsOnlyInstancesOf ($classname, $haystack, $message='')
static	assertAttributeContainsOnly ($type, $haystackAttributeName, $haystackClassOrObject, $isNativeType=null, $message='')
static	assertNotContainsOnly ($type, $haystack, $isNativeType=null, $message='')
static	assertAttributeNotContainsOnly ($type, $haystackAttributeName, $haystackClassOrObject, $isNativeType=null, $message='')
static	assertCount ($expectedCount, $haystack, $message='')
static	assertAttributeCount ($expectedCount, $haystackAttributeName, $haystackClassOrObject, $message='')
static	assertNotCount ($expectedCount, $haystack, $message='')
static	assertAttributeNotCount ($expectedCount, $haystackAttributeName, $haystackClassOrObject, $message='')
static	assertEquals ($expected, $actual, $message='', $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	assertAttributeEquals ($expected, $actualAttributeName, $actualClassOrObject, $message='', $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	assertNotEquals ($expected, $actual, $message='', $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	assertAttributeNotEquals ($expected, $actualAttributeName, $actualClassOrObject, $message='', $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	assertEmpty ($actual, $message='')
static	assertAttributeEmpty ($haystackAttributeName, $haystackClassOrObject, $message='')
static	assertNotEmpty ($actual, $message='')
static	assertAttributeNotEmpty ($haystackAttributeName, $haystackClassOrObject, $message='')
static	assertGreaterThan ($expected, $actual, $message='')
static	assertAttributeGreaterThan ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertGreaterThanOrEqual ($expected, $actual, $message='')
static	assertAttributeGreaterThanOrEqual ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertLessThan ($expected, $actual, $message='')
static	assertAttributeLessThan ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertLessThanOrEqual ($expected, $actual, $message='')
static	assertAttributeLessThanOrEqual ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertFileEquals ($expected, $actual, $message='', $canonicalize=false, $ignoreCase=false)
static	assertFileNotEquals ($expected, $actual, $message='', $canonicalize=false, $ignoreCase=false)
static	assertStringEqualsFile ($expectedFile, $actualString, $message='', $canonicalize=false, $ignoreCase=false)
static	assertStringNotEqualsFile ($expectedFile, $actualString, $message='', $canonicalize=false, $ignoreCase=false)
static	assertIsReadable ($filename, $message='')
static	assertNotIsReadable ($filename, $message='')
static	assertIsWritable ($filename, $message='')
static	assertNotIsWritable ($filename, $message='')
static	assertDirectoryExists ($directory, $message='')
static	assertDirectoryNotExists ($directory, $message='')
static	assertDirectoryIsReadable ($directory, $message='')
static	assertDirectoryNotIsReadable ($directory, $message='')
static	assertDirectoryIsWritable ($directory, $message='')
static	assertDirectoryNotIsWritable ($directory, $message='')
static	assertFileExists ($filename, $message='')
static	assertFileNotExists ($filename, $message='')
static	assertFileIsReadable ($file, $message='')
static	assertFileNotIsReadable ($file, $message='')
static	assertFileIsWritable ($file, $message='')
static	assertFileNotIsWritable ($file, $message='')
static	assertTrue ($condition, $message='')
static	assertNotTrue ($condition, $message='')
static	assertFalse ($condition, $message='')
static	assertNotFalse ($condition, $message='')
static	assertNull ($actual, $message='')
static	assertNotNull ($actual, $message='')
static	assertFinite ($actual, $message='')
static	assertInfinite ($actual, $message='')
static	assertNan ($actual, $message='')
static	assertClassHasAttribute ($attributeName, $className, $message='')
static	assertClassNotHasAttribute ($attributeName, $className, $message='')
static	assertClassHasStaticAttribute ($attributeName, $className, $message='')
static	assertClassNotHasStaticAttribute ($attributeName, $className, $message='')
static	assertObjectHasAttribute ($attributeName, $object, $message='')
static	assertObjectNotHasAttribute ($attributeName, $object, $message='')
static	assertSame ($expected, $actual, $message='')
static	assertAttributeSame ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertNotSame ($expected, $actual, $message='')
static	assertAttributeNotSame ($expected, $actualAttributeName, $actualClassOrObject, $message='')
static	assertInstanceOf ($expected, $actual, $message='')
static	assertAttributeInstanceOf ($expected, $attributeName, $classOrObject, $message='')
static	assertNotInstanceOf ($expected, $actual, $message='')
static	assertAttributeNotInstanceOf ($expected, $attributeName, $classOrObject, $message='')
static	assertInternalType ($expected, $actual, $message='')
static	assertAttributeInternalType ($expected, $attributeName, $classOrObject, $message='')
static	assertNotInternalType ($expected, $actual, $message='')
static	assertAttributeNotInternalType ($expected, $attributeName, $classOrObject, $message='')
static	assertRegExp ($pattern, $string, $message='')
static	assertNotRegExp ($pattern, $string, $message='')
static	assertSameSize ($expected, $actual, $message='')
static	assertNotSameSize ($expected, $actual, $message='')
static	assertStringMatchesFormat ($format, $string, $message='')
static	assertStringNotMatchesFormat ($format, $string, $message='')
static	assertStringMatchesFormatFile ($formatFile, $string, $message='')
static	assertStringNotMatchesFormatFile ($formatFile, $string, $message='')
static	assertStringStartsWith ($prefix, $string, $message='')
static	assertStringStartsNotWith ($prefix, $string, $message='')
static	assertStringEndsWith ($suffix, $string, $message='')
static	assertStringEndsNotWith ($suffix, $string, $message='')
static	assertXmlFileEqualsXmlFile ($expectedFile, $actualFile, $message='')
static	assertXmlFileNotEqualsXmlFile ($expectedFile, $actualFile, $message='')
static	assertXmlStringEqualsXmlFile ($expectedFile, $actualXml, $message='')
static	assertXmlStringNotEqualsXmlFile ($expectedFile, $actualXml, $message='')
static	assertXmlStringEqualsXmlString ($expectedXml, $actualXml, $message='')
static	assertXmlStringNotEqualsXmlString ($expectedXml, $actualXml, $message='')
static	assertEqualXMLStructure (DOMElement $expectedElement, DOMElement $actualElement, $checkAttributes=false, $message='')
static	assertThat ($value, Constraint $constraint, $message='')
static	assertJson ($actualJson, $message='')
static	assertJsonStringEqualsJsonString ($expectedJson, $actualJson, $message='')
static	assertJsonStringNotEqualsJsonString ($expectedJson, $actualJson, $message='')
static	assertJsonStringEqualsJsonFile ($expectedFile, $actualJson, $message='')
static	assertJsonStringNotEqualsJsonFile ($expectedFile, $actualJson, $message='')
static	assertJsonFileEqualsJsonFile ($expectedFile, $actualFile, $message='')
static	assertJsonFileNotEqualsJsonFile ($expectedFile, $actualFile, $message='')
static	logicalAnd ()
static	logicalOr ()
static	logicalNot (Constraint $constraint)
static	logicalXor ()
static	anything ()
static	isTrue ()
static	callback ($callback)
static	isFalse ()
static	isJson ()
static	isNull ()
static	isFinite ()
static	isInfinite ()
static	isNan ()
static	attribute (Constraint $constraint, $attributeName)
static	contains ($value, $checkForObjectIdentity=true, $checkForNonObjectIdentity=false)
static	containsOnly ($type)
static	containsOnlyInstancesOf ($classname)
static	arrayHasKey ($key)
static	equalTo ($value, $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	attributeEqualTo ($attributeName, $value, $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)
static	isEmpty ()
static	isWritable ()
static	isReadable ()
static	directoryExists ()
static	fileExists ()
static	greaterThan ($value)
static	greaterThanOrEqual ($value)
static	classHasAttribute ($attributeName)
static	classHasStaticAttribute ($attributeName)
static	objectHasAttribute ($attributeName)
static	identicalTo ($value)
static	isInstanceOf ($className)
static	isType ($type)
static	lessThan ($value)
static	lessThanOrEqual ($value)
static	matchesRegularExpression ($pattern)
static	matches ($string)
static	stringStartsWith ($prefix)
static	stringContains ($string, $case=true)
static	stringEndsWith ($suffix)
static	countOf ($count)
static	fail ($message='')
static	readAttribute ($classOrObject, $attributeName)
static	getStaticAttribute ($className, $attributeName)
static	getObjectAttribute ($object, $attributeName)
static	markTestIncomplete ($message='')
static	markTestSkipped ($message='')
static	getCount ()
static	resetCount ()

Protected Member Functions
	setExpectedExceptionFromAnnotation ()
	setUseErrorHandlerFromAnnotation ()
	checkRequirements ()
	runTest ()
	verifyMockObjects ()
	iniSet ($varName, $newValue)
	setLocale ()
	createMock ($originalClassName)
	createConfiguredMock ($originalClassName, array $configuration)
	createPartialMock ($originalClassName, array $methods)
	createTestProxy ($originalClassName, array $constructorArguments=[])
	getMockClass ($originalClassName, $methods=[], array $arguments=[], $mockClassName='', $callOriginalConstructor=false, $callOriginalClone=true, $callAutoload=true, $cloneArguments=false)
	getMockForAbstractClass ($originalClassName, array $arguments=[], $mockClassName='', $callOriginalConstructor=true, $callOriginalClone=true, $callAutoload=true, $mockedMethods=[], $cloneArguments=false)
	getMockFromWsdl ($wsdlFile, $originalClassName='', $mockClassName='', array $methods=[], $callOriginalConstructor=true, array $options=[])
	getMockForTrait ($traitName, array $arguments=[], $mockClassName='', $callOriginalConstructor=true, $callOriginalClone=true, $callAutoload=true, $mockedMethods=[], $cloneArguments=false)
	getObjectForTrait ($traitName, array $arguments=[], $traitClassName='', $callOriginalConstructor=true, $callOriginalClone=true, $callAutoload=true)
	prophesize ($classOrInterface=null)
	getProvidedData ()
	createResult ()
	handleDependencies ()
	setUp ()
	assertPreConditions ()
	assertPostConditions ()
	tearDown ()
	onNotSuccessfulTest (Throwable $t)
	prepareTemplate (Text_Template $template)

Protected Attributes
	$backupGlobals
	$backupGlobalsBlacklist = []
	$backupStaticAttributes
	$backupStaticAttributesBlacklist = []
	$runTestInSeparateProcess
	$preserveGlobalState = true

Detailed Description

A TestCase defines the fixture to run multiple tests.

To define a TestCase

1) Implement a subclass of PHPUnit\Framework\TestCase. 2) Define instance variables that store the state of the fixture. 3) Initialize the fixture state by overriding setUp(). 4) Clean-up after a test by overriding tearDown().

Each test runs in its own fixture so there can be no side effects among test runs.

Here is an example:

<?php class MathTest extends PHPUnit\Framework\TestCase { public $value1; public $value2;

protected function setUp() { $this->value1 = 2; $this->value2 = 3; } } ?>

For each test implement a method which interacts with the fixture. Verify the expected results with assertions specified by calling assert with a boolean.

<?php public function testPass() { $this->assertTrue($this->value1 + $this->value2 == 5); } ?>

Constructor & Destructor Documentation

__construct()

PHPUnit\Framework\TestCase::__construct	(		$name = null,
		array	$data = [],
			$dataName = ''
	)

Constructs a test case with the given name.

Parameters

string	$name
array	$data
string	$dataName

Member Function Documentation

addToAssertionCount()

PHPUnit\Framework\TestCase::addToAssertionCount

(

$count

)

Adds a value to the assertion counter.

Parameters

int

$count

any()

static PHPUnit\Framework\TestCase::any ( )

static

Returns a matcher that matches when the method is executed zero or more times.

Returns

AnyInvokedCountMatcher

assertPostConditions()

PHPUnit\Framework\TestCase::assertPostConditions ( )

protected

Performs assertions shared by all tests of a test case.

This method is called after the execution of a test ends and before tearDown() is called.

Reimplemented in TemplateMethodsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTest, ExceptionInAssertPostConditionsTest, and ExceptionInTearDownTest.

assertPreConditions()

PHPUnit\Framework\TestCase::assertPreConditions ( )

protected

Performs assertions shared by all tests of a test case.

This method is called before the execution of a test starts and after setUp() is called.

Reimplemented in ExceptionInSetUpTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInTearDownTest, ExceptionInTest, and TemplateMethodsTest.

at()

static PHPUnit\Framework\TestCase::at (   $index )

static

Returns a matcher that matches when the method is executed at the given index.

Parameters

int

$index

Returns

InvokedAtIndexMatcher

atLeast()

static PHPUnit\Framework\TestCase::atLeast (   $requiredInvocations )

static

Returns a matcher that matches when the method is executed at least N times.

Parameters

int

$requiredInvocations

Returns

InvokedAtLeastCountMatcher

atLeastOnce()

static PHPUnit\Framework\TestCase::atLeastOnce ( )

static

Returns a matcher that matches when the method is executed at least once.

Returns

InvokedAtLeastOnceMatcher

atMost()

static PHPUnit\Framework\TestCase::atMost (   $allowedInvocations )

static

Returns a matcher that matches when the method is executed at most N times.

Parameters

int

$allowedInvocations

Returns

InvokedAtMostCountMatcher

count()

PHPUnit\Framework\TestCase::count

(

)

Counts the number of test cases executed by run(TestResult result).

Returns

int

createConfiguredMock()

PHPUnit\Framework\TestCase::createConfiguredMock (   $originalClassName, array  $configuration  )

protected

Returns a configured test double for the specified class.

Parameters

string	$originalClassName
array	$configuration

Returns

MockObject

Exceptions

Exception

createMock()

PHPUnit\Framework\TestCase::createMock (   $originalClassName )

protected

Returns a test double for the specified class.

Parameters

string

$originalClassName

Returns

MockObject

Exceptions

Exception

createPartialMock()

PHPUnit\Framework\TestCase::createPartialMock (   $originalClassName, array  $methods  )

protected

Returns a partial test double for the specified class.

Parameters

string	$originalClassName
string[]	$methods

Returns

MockObject

Exceptions

Exception

createResult()

PHPUnit\Framework\TestCase::createResult ( )

protected

Creates a default TestResult object.

Returns

TestResult

createTestProxy()

PHPUnit\Framework\TestCase::createTestProxy (   $originalClassName, array  $constructorArguments = []  )

protected

Returns a test proxy for the specified class.

Parameters

string	$originalClassName
array	$constructorArguments

Returns

MockObject

Exceptions

Exception

dataDescription()

PHPUnit\Framework\TestCase::dataDescription

(

)

Returns

string

dataName()

PHPUnit\Framework\TestCase::dataName

(

)

Returns

int|string

doesNotPerformAssertions()

PHPUnit\Framework\TestCase::doesNotPerformAssertions

(

)

Returns

bool

exactly()

static PHPUnit\Framework\TestCase::exactly (   $count )

static

Returns a matcher that matches when the method is executed exactly $count times.

Parameters

int

$count

Returns

InvokedCountMatcher

expectException()

PHPUnit\Framework\TestCase::expectException

(

$exception

)

Parameters

string

$exception

expectExceptionCode()

PHPUnit\Framework\TestCase::expectExceptionCode

(

$code

)

Parameters

int | string

$code

Exceptions

Exception

expectExceptionMessage()

PHPUnit\Framework\TestCase::expectExceptionMessage

(

$message

)

Parameters

string

$message

Exceptions

Exception

expectExceptionMessageRegExp()

PHPUnit\Framework\TestCase::expectExceptionMessageRegExp

(

$messageRegExp

)

Parameters

string

$messageRegExp

Exceptions

Exception

expectExceptionObject()

PHPUnit\Framework\TestCase::expectExceptionObject

(

\Exception

$exception

)

Sets up an expectation for an exception to be raised by the code under test. Information for expected exception class, expected exception message, and expected exception code are retrieved from a given Exception object.

expectOutputRegex()

PHPUnit\Framework\TestCase::expectOutputRegex

(

$expectedRegex

)

Parameters

string

$expectedRegex

Exceptions

Exception

expectOutputString()

PHPUnit\Framework\TestCase::expectOutputString

(

$expectedString

)

Parameters

string

$expectedString

getActualOutput()

PHPUnit\Framework\TestCase::getActualOutput

(

)

Returns

string

getAnnotations()

PHPUnit\Framework\TestCase::getAnnotations

(

)

Returns the annotations for this test.

Returns

array

getDataSetAsString()

PHPUnit\Framework\TestCase::getDataSetAsString

(

$includeData = true

)

Gets the data set description of a TestCase.

Parameters

bool

$includeData

Returns

string

getExpectedException()

PHPUnit\Framework\TestCase::getExpectedException

(

)

Returns

null|string

getExpectedExceptionCode()

PHPUnit\Framework\TestCase::getExpectedExceptionCode

(

)

Returns

null|int|string

getExpectedExceptionMessage()

PHPUnit\Framework\TestCase::getExpectedExceptionMessage

(

)

Returns

string

getExpectedExceptionMessageRegExp()

PHPUnit\Framework\TestCase::getExpectedExceptionMessageRegExp

(

)

Returns

string

getMockBuilder()

PHPUnit\Framework\TestCase::getMockBuilder

(

$className

)

Returns a builder object to create mock objects using a fluent interface.

Parameters

string | string[]

$className

Returns

MockBuilder

getMockClass()

PHPUnit\Framework\TestCase::getMockClass (   $originalClassName,   $methods = [], array  $arguments = [],   $mockClassName = '',   $callOriginalConstructor = false,   $callOriginalClone = true,   $callAutoload = true,   $cloneArguments = false  )

protected

Mocks the specified class and returns the name of the mocked class.

Parameters

string	$originalClassName
array	$methods
array	$arguments
string	$mockClassName
bool	$callOriginalConstructor
bool	$callOriginalClone
bool	$callAutoload
bool	$cloneArguments

Returns

string

Exceptions

Exception

getMockForAbstractClass()

PHPUnit\Framework\TestCase::getMockForAbstractClass (   $originalClassName, array  $arguments = [],   $mockClassName = '',   $callOriginalConstructor = true,   $callOriginalClone = true,   $callAutoload = true,   $mockedMethods = [],   $cloneArguments = false  )

protected

Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default. To mock concrete methods, use the 7th parameter ($mockedMethods).

Parameters

string	$originalClassName
array	$arguments
string	$mockClassName
bool	$callOriginalConstructor
bool	$callOriginalClone
bool	$callAutoload
array	$mockedMethods
bool	$cloneArguments

Returns

MockObject

Exceptions

Exception

getMockForTrait()

PHPUnit\Framework\TestCase::getMockForTrait (   $traitName, array  $arguments = [],   $mockClassName = '',   $callOriginalConstructor = true,   $callOriginalClone = true,   $callAutoload = true,   $mockedMethods = [],   $cloneArguments = false  )

protected

Returns a mock object for the specified trait with all abstract methods of the trait mocked. Concrete methods to mock can be specified with the $mockedMethods parameter.

Parameters

string	$traitName
array	$arguments
string	$mockClassName
bool	$callOriginalConstructor
bool	$callOriginalClone
bool	$callAutoload
array	$mockedMethods
bool	$cloneArguments

Returns

MockObject

Exceptions

Exception

getMockFromWsdl()

PHPUnit\Framework\TestCase::getMockFromWsdl (   $wsdlFile,   $originalClassName = '',   $mockClassName = '', array  $methods = [],   $callOriginalConstructor = true, array  $options = []  )

protected

Returns a mock object based on the given WSDL file.

Parameters

string	$wsdlFile
string	$originalClassName
string	$mockClassName
array	$methods
bool	$callOriginalConstructor
array	$options	An array of options passed to SOAPClient::_construct

Returns

MockObject

getName()

PHPUnit\Framework\TestCase::getName

(

$withDataSet = true

)

Gets the name of a TestCase.

Parameters

bool

$withDataSet

Returns

string

getNumAssertions()

PHPUnit\Framework\TestCase::getNumAssertions

(

)

Returns the number of assertions performed by this test.

Returns

int

getObjectForTrait()

PHPUnit\Framework\TestCase::getObjectForTrait (   $traitName, array  $arguments = [],   $traitClassName = '',   $callOriginalConstructor = true,   $callOriginalClone = true,   $callAutoload = true  )

protected

Returns an object for the specified trait.

Parameters

string	$traitName
array	$arguments
string	$traitClassName
bool	$callOriginalConstructor
bool	$callOriginalClone
bool	$callAutoload

Returns

object

Exceptions

Exception

getProvidedData()

PHPUnit\Framework\TestCase::getProvidedData ( )

protected

Gets the data set of a TestCase.

Returns

array

getResult()

PHPUnit\Framework\TestCase::getResult

(

)

Returns

mixed

getSize()

PHPUnit\Framework\TestCase::getSize

(

)

Returns the size of the test.

Returns

int

getStatus()

PHPUnit\Framework\TestCase::getStatus

(

)

Returns the status of this test.

Returns

int

getStatusMessage()

PHPUnit\Framework\TestCase::getStatusMessage

(

)

Returns the status message of this test.

Returns

string

getTestResultObject()

PHPUnit\Framework\TestCase::getTestResultObject

(

)

Returns

TestResult

hasDependencies()

PHPUnit\Framework\TestCase::hasDependencies

(

)

Returns true if the tests has dependencies

Returns

bool

hasExpectationOnOutput()

PHPUnit\Framework\TestCase::hasExpectationOnOutput

(

)

Returns

bool

hasFailed()

PHPUnit\Framework\TestCase::hasFailed

(

)

Returns whether or not this test has failed.

Returns

bool

hasOutput()

PHPUnit\Framework\TestCase::hasOutput

(

)

Returns

bool

hasSize()

PHPUnit\Framework\TestCase::hasSize

(

)

Returns

bool

iniSet()

PHPUnit\Framework\TestCase::iniSet (   $varName,   $newValue  )

protected

This method is a wrapper for the ini_set() function that automatically resets the modified php.ini setting to its original value after the test is run.

Parameters

string	$varName
string	$newValue

Exceptions

Exception

isInIsolation()

PHPUnit\Framework\TestCase::isInIsolation

(

)

Returns

bool

isLarge()

PHPUnit\Framework\TestCase::isLarge

(

)

Returns

bool

isMedium()

PHPUnit\Framework\TestCase::isMedium

(

)

Returns

bool

isSmall()

PHPUnit\Framework\TestCase::isSmall

(

)

Returns

bool

never()

static PHPUnit\Framework\TestCase::never ( )

static

Returns a matcher that matches when the method is never executed.

Returns

InvokedCountMatcher

once()

static PHPUnit\Framework\TestCase::once ( )

static

Returns a matcher that matches when the method is executed exactly once.

Returns

InvokedCountMatcher

onConsecutiveCalls()

static PHPUnit\Framework\TestCase::onConsecutiveCalls ( )

static

Parameters

mixed

$value,...

Returns

ConsecutiveCallsStub

onNotSuccessfulTest()

PHPUnit\Framework\TestCase::onNotSuccessfulTest ( Throwable  $t )

protected

This method is called when a test method did not execute successfully.

Parameters

Throwable

$t

Exceptions

Throwable

prepareTemplate()

PHPUnit\Framework\TestCase::prepareTemplate ( Text_Template  $template )

protected

Performs custom preparations on the process isolation template.

Parameters

Text_Template

$template

prophesize()

PHPUnit\Framework\TestCase::prophesize (   $classOrInterface = null )

protected

Parameters

string | null

$classOrInterface

Returns

\Prophecy\Prophecy\ObjectProphecy

Exceptions

registerMockObject()

PHPUnit\Framework\TestCase::registerMockObject

(

MockObject

$mockObject

)

Parameters

MockObject

$mockObject

returnArgument()

static PHPUnit\Framework\TestCase::returnArgument (   $argumentIndex )

static

Parameters

int

$argumentIndex

Returns

ReturnArgumentStub

returnCallback()

static PHPUnit\Framework\TestCase::returnCallback (   $callback )

static

Parameters

mixed

$callback

Returns

ReturnCallbackStub

returnSelf()

static PHPUnit\Framework\TestCase::returnSelf ( )

static

Returns the current object.

This method is useful when mocking a fluent interface.

Returns

ReturnSelfStub

returnValue()

static PHPUnit\Framework\TestCase::returnValue (   $value )

static

Parameters

mixed

$value

Returns

ReturnStub

returnValueMap()

static PHPUnit\Framework\TestCase::returnValueMap ( array  $valueMap )

static

Parameters

array

$valueMap

Returns

ReturnValueMapStub

run()

PHPUnit\Framework\TestCase::run

(

TestResult

$result = null

)

Runs the test case and collects the results in a TestResult object. If no TestResult object is passed a new one will be created.

Parameters

TestResult

$result

Returns

TestResult

Exceptions

Exception

Implements PHPUnit\Framework\Test.

runBare()

PHPUnit\Framework\TestCase::runBare

(

)

Runs the bare test sequence.

runTest()

PHPUnit\Framework\TestCase::runTest ( )

protected

Override to run the test and assert its state.

Returns

mixed

Exceptions

Exception|Exception
Exception

Reimplemented in PHPUnit\Framework\IncompleteTestCase, PHPUnit\Framework\SkippedTestCase, PHPUnit\Framework\WarningTestCase, WasRun, Failure, Success, TestIncomplete, TestSkipped, and TestError.

setBackupGlobals()

PHPUnit\Framework\TestCase::setBackupGlobals

(

$backupGlobals

)

Calling this method in setUp() has no effect!

Parameters

bool

$backupGlobals

setBackupStaticAttributes()

PHPUnit\Framework\TestCase::setBackupStaticAttributes

(

$backupStaticAttributes

)

Calling this method in setUp() has no effect!

Parameters

bool

$backupStaticAttributes

setBeStrictAboutChangesToGlobalState()

PHPUnit\Framework\TestCase::setBeStrictAboutChangesToGlobalState

(

$beStrictAboutChangesToGlobalState

)

Parameters

bool

$beStrictAboutChangesToGlobalState

setDependencies()

PHPUnit\Framework\TestCase::setDependencies

(

array

$dependencies

)

Sets the dependencies of a TestCase.

Parameters

string[]

$dependencies

setDependencyInput()

PHPUnit\Framework\TestCase::setDependencyInput

(

array

$dependencyInput

)

Sets

Parameters

array

$dependencyInput

setGroups()

PHPUnit\Framework\TestCase::setGroups

(

array

$groups

)

Parameters

array

$groups

setInIsolation()

PHPUnit\Framework\TestCase::setInIsolation

(

$inIsolation

)

Parameters

bool

$inIsolation

Exceptions

Exception

setLocale()

PHPUnit\Framework\TestCase::setLocale ( )

protected

This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.

Parameters

int	$category
string	$locale

Exceptions

Exception

setName()

PHPUnit\Framework\TestCase::setName

(

$name

)

Sets the name of a TestCase.

Parameters

string

setOutputCallback()

PHPUnit\Framework\TestCase::setOutputCallback

(

$callback

)

Parameters

callable

$callback

Exceptions

Exception

setPreserveGlobalState()

PHPUnit\Framework\TestCase::setPreserveGlobalState

(

$preserveGlobalState

)

Parameters

bool

$preserveGlobalState

Exceptions

Exception

setRegisterMockObjectsFromTestArgumentsRecursively()

PHPUnit\Framework\TestCase::setRegisterMockObjectsFromTestArgumentsRecursively

(

$flag

)

Parameters

bool

$flag

setResult()

PHPUnit\Framework\TestCase::setResult

(

$result

)

Parameters

mixed

$result

setRunClassInSeparateProcess()

PHPUnit\Framework\TestCase::setRunClassInSeparateProcess

(

$runClassInSeparateProcess

)

Parameters

bool

$runClassInSeparateProcess

Exceptions

Exception

setRunTestInSeparateProcess()

PHPUnit\Framework\TestCase::setRunTestInSeparateProcess

(

$runTestInSeparateProcess

)

Parameters

bool

$runTestInSeparateProcess

Exceptions

Exception

setTestResultObject()

PHPUnit\Framework\TestCase::setTestResultObject

(

TestResult

$result

)

Parameters

TestResult

$result

setUp()

PHPUnit\Framework\TestCase::setUp ( )

protected

Sets up the fixture, for example, open a network connection. This method is called before a test is executed.

Reimplemented in PHPUnit\Framework\TestListenerTest, PharIo\Manifest\ManifestTest, PHPUnit\Runner\PhptTestCaseTest, PharIo\Manifest\CopyrightInformationTest, PharIo\Manifest\ExtensionTest, GeneratorTest, SebastianBergmann\Diff\LongestCommonSubsequenceTest, PharIo\Manifest\BundledComponentCollectionTest, PharIo\Manifest\RequirementCollectionTest, PharIo\Manifest\AuthorCollectionTest, SebastianBergmann\Comparator\DateTimeComparatorTest, SebastianBergmann\GlobalState\BlacklistTest, SebastianBergmann\GlobalState\SnapshotTest, SebastianBergmann\Comparator\ArrayComparatorTest, SebastianBergmann\Diff\ParserTest, SebastianBergmann\ObjectReflector\ObjectReflectorTest, SebastianBergmann\Comparator\DOMNodeComparatorTest, SebastianBergmann\Comparator\ExceptionComparatorTest, SebastianBergmann\Comparator\SplObjectStorageComparatorTest, PharIo\Manifest\BundledComponentTest, PharIo\Manifest\PhpVersionRequirementTest, SebastianBergmann\CodeCoverage\FilterTest, SebastianBergmann\Comparator\MockObjectComparatorTest, SebastianBergmann\Comparator\ObjectComparatorTest, SebastianBergmann\Comparator\TypeComparatorTest, SebastianBergmann\Environment\ConsoleTest, SebastianBergmann\Environment\OperatingSystemTest, SebastianBergmann\Environment\RuntimeTest, PharIo\Manifest\AuthorTest, PharIo\Manifest\LicenseTest, SebastianBergmann\CodeCoverage\CodeCoverageTest, SebastianBergmann\Comparator\DoubleComparatorTest, SebastianBergmann\Comparator\NumericComparatorTest, SebastianBergmann\Comparator\ResourceComparatorTest, SebastianBergmann\Comparator\ScalarComparatorTest, SebastianBergmann\ObjectEnumerator\EnumeratorTest, PharIo\Manifest\ApplicationTest, PharIo\Manifest\LibraryTest, PHP_Token_ClassTest, PHP_Token_InterfaceTest, SebastianBergmann\CodeUnitReverseLookup\WizardTest, SebastianBergmann\Diff\ChunkTest, SebastianBergmann\Diff\LineTest, SebastianBergmann\Exporter\ExporterTest, SebastianBergmann\RecursionContext\ContextTest, PHPUnit\Util\ConfigurationTest, PHPUnit\Util\PHP\AbstractPhpProcessTest, SebastianBergmann\Diff\DifferTestTest, PHPUnit\Util\TestDox\NamePrettifierTest, SebastianBergmann\CodeCoverage\Report\BuilderTest, PHP_Token_ClosureTest, PHP_Token_FunctionTest, PHP_Token_IncludeTest, PHPUnit\Framework\SuiteTest, BankAccountTest, BankAccountWithCustomExtensionTest, BankAccountTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTearDownTest, ExceptionInTest, TemplateMethodsTest, BankAccountTest, and Issue1374Test.

setUpBeforeClass()

static PHPUnit\Framework\TestCase::setUpBeforeClass ( )

static

This method is called before the first test of this test class is run.

Reimplemented in SebastianBergmann\CodeCoverage\TestCase, PHPUnit\Framework\TestCaseTest, SebastianBergmann\GlobalState\RestorerTest, SebastianBergmann\CodeCoverage\Report\Html\HTMLTest, SebastianBergmann\CodeCoverage\Report\Xml\XMLTest, ServersTest, BeforeClassWithOnlyDataProviderTest, AdminConfigTest, ConfigTest, RequirementsClassBeforeClassHookTest, ClonedDependencyTest, TemplateMethodsTest, and Issue2145Test.

setUseErrorHandler()

PHPUnit\Framework\TestCase::setUseErrorHandler

(

$useErrorHandler

)

Parameters

bool

$useErrorHandler

tearDown()

PHPUnit\Framework\TestCase::tearDown ( )

protected

Tears down the fixture, for example, close a network connection. This method is called after a test is executed.

Reimplemented in PHPUnit\Runner\PhptTestCaseTest, SebastianBergmann\Diff\LongestCommonSubsequenceTest, TemplateMethodsTest, ExceptionInAssertPostConditionsTest, ExceptionInAssertPreConditionsTest, ExceptionInSetUpTest, ExceptionInTest, ExceptionInTearDownTest, SebastianBergmann\CodeCoverage\Report\Html\HTMLTest, SebastianBergmann\CodeCoverage\Report\Xml\XMLTest, and Issue1374Test.

tearDownAfterClass()

static PHPUnit\Framework\TestCase::tearDownAfterClass ( )

static

This method is called after the last test of this test class is run.

Reimplemented in TemplateMethodsTest, and PHPUnit\Framework\TestCaseTest.

throwException()

static PHPUnit\Framework\TestCase::throwException ( Throwable  $exception )

static

Parameters

Throwable

$exception

Returns

ExceptionStub

toString()

PHPUnit\Framework\TestCase::toString

(

)

Returns a string representation of the test case.

Returns

string

Implements PHPUnit\Framework\SelfDescribing.

Reimplemented in PHPUnit\Framework\IncompleteTestCase, PHPUnit\Framework\SkippedTestCase, and PHPUnit\Framework\WarningTestCase.

usesDataProvider()

PHPUnit\Framework\TestCase::usesDataProvider

(

)

Returns

bool

verifyMockObjects()

PHPUnit\Framework\TestCase::verifyMockObjects ( )

protected

Verifies the mock object expectations.

---

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

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