Inheritance diagram for PHPUnit\Framework\Assert:

Detailed Description

A set of assertion methods.

Static Public Member Functions
static	assertArrayHasKey ($key, $array, string $message='')

static	assertArraySubset ($subset, $array, bool $checkForObjectIdentity=false, string $message='')

static	assertArrayNotHasKey ($key, $array, string $message='')

static	assertContains ($needle, $haystack, string $message='', bool $ignoreCase=false, bool $checkForObjectIdentity=true, bool $checkForNonObjectIdentity=false)

static	assertContainsEquals ($needle, iterable $haystack, string $message='')

static	assertAttributeContains ($needle, string $haystackAttributeName, $haystackClassOrObject, string $message='', bool $ignoreCase=false, bool $checkForObjectIdentity=true, bool $checkForNonObjectIdentity=false)

static	assertNotContains ($needle, $haystack, string $message='', bool $ignoreCase=false, bool $checkForObjectIdentity=true, bool $checkForNonObjectIdentity=false)

static	assertNotContainsEquals ($needle, iterable $haystack, string $message='')

static	assertAttributeNotContains ($needle, string $haystackAttributeName, $haystackClassOrObject, string $message='', bool $ignoreCase=false, bool $checkForObjectIdentity=true, bool $checkForNonObjectIdentity=false)

static	assertContainsOnly (string $type, iterable $haystack, ?bool $isNativeType=null, string $message='')

static	assertContainsOnlyInstancesOf (string $className, iterable $haystack, string $message='')

static	assertAttributeContainsOnly (string $type, string $haystackAttributeName, $haystackClassOrObject, ?bool $isNativeType=null, string $message='')

static	assertNotContainsOnly (string $type, iterable $haystack, ?bool $isNativeType=null, string $message='')

static	assertAttributeNotContainsOnly (string $type, string $haystackAttributeName, $haystackClassOrObject, ?bool $isNativeType=null, string $message='')

static	assertCount (int $expectedCount, $haystack, string $message='')

static	assertAttributeCount (int $expectedCount, string $haystackAttributeName, $haystackClassOrObject, string $message='')

static	assertNotCount (int $expectedCount, $haystack, string $message='')

static	assertAttributeNotCount (int $expectedCount, string $haystackAttributeName, $haystackClassOrObject, string $message='')

static	assertEquals ($expected, $actual, string $message='', float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)

static	assertEqualsCanonicalizing ($expected, $actual, string $message='')

static	assertEqualsIgnoringCase ($expected, $actual, string $message='')

static	assertEqualsWithDelta ($expected, $actual, float $delta, string $message='')

static	assertAttributeEquals ($expected, string $actualAttributeName, $actualClassOrObject, string $message='', float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)

static	assertNotEquals ($expected, $actual, string $message='', $delta=0.0, $maxDepth=10, $canonicalize=false, $ignoreCase=false)

static	assertNotEqualsCanonicalizing ($expected, $actual, string $message='')

static	assertNotEqualsIgnoringCase ($expected, $actual, string $message='')

static	assertNotEqualsWithDelta ($expected, $actual, float $delta, string $message='')

static	assertAttributeNotEquals ($expected, string $actualAttributeName, $actualClassOrObject, string $message='', float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)

static	assertEmpty ($actual, string $message='')

static	assertAttributeEmpty (string $haystackAttributeName, $haystackClassOrObject, string $message='')

static	assertNotEmpty ($actual, string $message='')

static	assertAttributeNotEmpty (string $haystackAttributeName, $haystackClassOrObject, string $message='')

static	assertGreaterThan ($expected, $actual, string $message='')

static	assertAttributeGreaterThan ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertGreaterThanOrEqual ($expected, $actual, string $message='')

static	assertAttributeGreaterThanOrEqual ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertLessThan ($expected, $actual, string $message='')

static	assertAttributeLessThan ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertLessThanOrEqual ($expected, $actual, string $message='')

static	assertAttributeLessThanOrEqual ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertFileEquals (string $expected, string $actual, string $message='', bool $canonicalize=false, bool $ignoreCase=false)

static	assertFileEqualsCanonicalizing (string $expected, string $actual, string $message='')

static	assertFileEqualsIgnoringCase (string $expected, string $actual, string $message='')

static	assertFileNotEquals (string $expected, string $actual, string $message='', bool $canonicalize=false, bool $ignoreCase=false)

static	assertFileNotEqualsCanonicalizing (string $expected, string $actual, string $message='')

static	assertFileNotEqualsIgnoringCase (string $expected, string $actual, string $message='')

static	assertStringEqualsFile (string $expectedFile, string $actualString, string $message='', bool $canonicalize=false, bool $ignoreCase=false)

static	assertStringEqualsFileCanonicalizing (string $expectedFile, string $actualString, string $message='')

static	assertStringEqualsFileIgnoringCase (string $expectedFile, string $actualString, string $message='')

static	assertStringNotEqualsFile (string $expectedFile, string $actualString, string $message='', bool $canonicalize=false, bool $ignoreCase=false)

static	assertStringNotEqualsFileCanonicalizing (string $expectedFile, string $actualString, string $message='')

static	assertStringNotEqualsFileIgnoringCase (string $expectedFile, string $actualString, string $message='')

static	assertIsReadable (string $filename, string $message='')

static	assertNotIsReadable (string $filename, string $message='')

static	assertIsWritable (string $filename, string $message='')

static	assertNotIsWritable (string $filename, string $message='')

static	assertDirectoryExists (string $directory, string $message='')

static	assertDirectoryNotExists (string $directory, string $message='')

static	assertDirectoryIsReadable (string $directory, string $message='')

static	assertDirectoryNotIsReadable (string $directory, string $message='')

static	assertDirectoryIsWritable (string $directory, string $message='')

static	assertDirectoryNotIsWritable (string $directory, string $message='')

static	assertFileExists (string $filename, string $message='')

static	assertFileNotExists (string $filename, string $message='')

static	assertFileIsReadable (string $file, string $message='')

static	assertFileNotIsReadable (string $file, string $message='')

static	assertFileIsWritable (string $file, string $message='')

static	assertFileNotIsWritable (string $file, string $message='')

static	assertTrue ($condition, string $message='')

static	assertNotTrue ($condition, string $message='')

static	assertFalse ($condition, string $message='')

static	assertNotFalse ($condition, string $message='')

static	assertNull ($actual, string $message='')

static	assertNotNull ($actual, string $message='')

static	assertFinite ($actual, string $message='')

static	assertInfinite ($actual, string $message='')

static	assertNan ($actual, string $message='')

static	assertClassHasAttribute (string $attributeName, string $className, string $message='')

static	assertClassNotHasAttribute (string $attributeName, string $className, string $message='')

static	assertClassHasStaticAttribute (string $attributeName, string $className, string $message='')

static	assertClassNotHasStaticAttribute (string $attributeName, string $className, string $message='')

static	assertObjectHasAttribute (string $attributeName, $object, string $message='')

static	assertObjectNotHasAttribute (string $attributeName, $object, string $message='')

static	assertSame ($expected, $actual, string $message='')

static	assertAttributeSame ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertNotSame ($expected, $actual, string $message='')

static	assertAttributeNotSame ($expected, string $actualAttributeName, $actualClassOrObject, string $message='')

static	assertInstanceOf (string $expected, $actual, string $message='')

static	assertAttributeInstanceOf (string $expected, string $attributeName, $classOrObject, string $message='')

static	assertNotInstanceOf (string $expected, $actual, string $message='')

static	assertAttributeNotInstanceOf (string $expected, string $attributeName, $classOrObject, string $message='')

static	assertInternalType (string $expected, $actual, string $message='')

static	assertAttributeInternalType (string $expected, string $attributeName, $classOrObject, string $message='')

static	assertIsArray ($actual, string $message='')

static	assertIsBool ($actual, string $message='')

static	assertIsFloat ($actual, string $message='')

static	assertIsInt ($actual, string $message='')

static	assertIsNumeric ($actual, string $message='')

static	assertIsObject ($actual, string $message='')

static	assertIsResource ($actual, string $message='')

static	assertIsString ($actual, string $message='')

static	assertIsScalar ($actual, string $message='')

static	assertIsCallable ($actual, string $message='')

static	assertIsIterable ($actual, string $message='')

static	assertNotInternalType (string $expected, $actual, string $message='')

static	assertIsNotArray ($actual, string $message='')

static	assertIsNotBool ($actual, string $message='')

static	assertIsNotFloat ($actual, string $message='')

static	assertIsNotInt ($actual, string $message='')

static	assertIsNotNumeric ($actual, string $message='')

static	assertIsNotObject ($actual, string $message='')

static	assertIsNotResource ($actual, string $message='')

static	assertIsNotString ($actual, string $message='')

static	assertIsNotScalar ($actual, string $message='')

static	assertIsNotCallable ($actual, string $message='')

static	assertIsNotIterable ($actual, string $message='')

static	assertAttributeNotInternalType (string $expected, string $attributeName, $classOrObject, string $message='')

static	assertRegExp (string $pattern, string $string, string $message='')

static	assertNotRegExp (string $pattern, string $string, string $message='')

static	assertSameSize ($expected, $actual, string $message='')

static	assertNotSameSize ($expected, $actual, string $message='')

static	assertStringMatchesFormat (string $format, string $string, string $message='')

static	assertStringNotMatchesFormat (string $format, string $string, string $message='')

static	assertStringMatchesFormatFile (string $formatFile, string $string, string $message='')

static	assertStringNotMatchesFormatFile (string $formatFile, string $string, string $message='')

static	assertStringStartsWith (string $prefix, string $string, string $message='')

static	assertStringStartsNotWith ($prefix, $string, string $message='')

static	assertStringContainsString (string $needle, string $haystack, string $message='')

static	assertStringContainsStringIgnoringCase (string $needle, string $haystack, string $message='')

static	assertStringNotContainsString (string $needle, string $haystack, string $message='')

static	assertStringNotContainsStringIgnoringCase (string $needle, string $haystack, string $message='')

static	assertStringEndsWith (string $suffix, string $string, string $message='')

static	assertStringEndsNotWith (string $suffix, string $string, string $message='')

static	assertXmlFileEqualsXmlFile (string $expectedFile, string $actualFile, string $message='')

static	assertXmlFileNotEqualsXmlFile (string $expectedFile, string $actualFile, string $message='')

static	assertXmlStringEqualsXmlFile (string $expectedFile, $actualXml, string $message='')

static	assertXmlStringNotEqualsXmlFile (string $expectedFile, $actualXml, string $message='')

static	assertXmlStringEqualsXmlString ($expectedXml, $actualXml, string $message='')

static	assertXmlStringNotEqualsXmlString ($expectedXml, $actualXml, string $message='')

static	assertEqualXMLStructure (DOMElement $expectedElement, DOMElement $actualElement, bool $checkAttributes=false, string $message='')

static	assertThat ($value, Constraint $constraint, string $message='')

static	assertJson (string $actualJson, string $message='')

static	assertJsonStringEqualsJsonString (string $expectedJson, string $actualJson, string $message='')

static	assertJsonStringNotEqualsJsonString ($expectedJson, $actualJson, string $message='')

static	assertJsonStringEqualsJsonFile (string $expectedFile, string $actualJson, string $message='')

static	assertJsonStringNotEqualsJsonFile (string $expectedFile, string $actualJson, string $message='')

static	assertJsonFileEqualsJsonFile (string $expectedFile, string $actualFile, string $message='')

static	assertJsonFileNotEqualsJsonFile (string $expectedFile, string $actualFile, string $message='')

static	logicalAnd ()

static	logicalOr ()

static	logicalNot (Constraint $constraint)

static	logicalXor ()

static	anything ()

static	isTrue ()

static	callback (callable $callback)

static	isFalse ()

static	isJson ()

static	isNull ()

static	isFinite ()

static	isInfinite ()

static	isNan ()

static	attribute (Constraint $constraint, string $attributeName)

static	contains ($value, bool $checkForObjectIdentity=true, bool $checkForNonObjectIdentity=false)

static	containsEqual ($value)

static	containsIdentical ($value)

static	containsOnly (string $type)

static	containsOnlyInstancesOf (string $className)

static	arrayHasKey ($key)

static	equalTo ($value, float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)

static	attributeEqualTo (string $attributeName, $value, float $delta=0.0, int $maxDepth=10, bool $canonicalize=false, bool $ignoreCase=false)

static	isEmpty ()

static	isWritable ()

static	isReadable ()

static	directoryExists ()

static	fileExists ()

static	greaterThan ($value)

static	greaterThanOrEqual ($value)

static	classHasAttribute (string $attributeName)

static	classHasStaticAttribute (string $attributeName)

static	objectHasAttribute ($attributeName)

static	identicalTo ($value)

static	isInstanceOf (string $className)

static	isType (string $type)

static	lessThan ($value)

static	lessThanOrEqual ($value)

static	matchesRegularExpression (string $pattern)

static	matches (string $string)

static	stringStartsWith ($prefix)

static	stringContains (string $string, bool $case=true)

static	stringEndsWith (string $suffix)

static	countOf (int $count)

static	fail (string $message='')

static	readAttribute ($classOrObject, string $attributeName)

static	getStaticAttribute (string $className, string $attributeName)

static	getObjectAttribute ($object, string $attributeName)

static	markTestIncomplete (string $message='')

static	markTestSkipped (string $message='')

static	getCount ()

static	resetCount ()

Member Function Documentation

◆ anything()

static PHPUnit\Framework\Assert::anything ( )

static

◆ arrayHasKey()

static PHPUnit\Framework\Assert::arrayHasKey ( $key )

static

Parameters

int | string $key

◆ assertArrayHasKey()

static PHPUnit\Framework\Assert::assertArrayHasKey	(		$key,
			$array,
		string	$message = `''`
	)

static

Asserts that an array has a specified key.

Parameters

int \| string	$key
array \| ArrayAccess	$array

Exceptions

ExpectationFailedException

◆ assertArrayNotHasKey()

static PHPUnit\Framework\Assert::assertArrayNotHasKey	(		$key,
			$array,
		string	$message = `''`
	)

static

Asserts that an array does not have a specified key.

Parameters

int \| string	$key
array \| ArrayAccess	$array

Exceptions

ExpectationFailedException

◆ assertArraySubset()

static PHPUnit\Framework\Assert::assertArraySubset	(		$subset,
			$array,
		bool	$checkForObjectIdentity = `false`,
		string	$message = `''`
	)

static

Asserts that an array has a specified subset.

Parameters

array \| ArrayAccess	$subset
array \| ArrayAccess	$array

Exceptions

ExpectationFailedException

◆ assertAttributeContains()

static PHPUnit\Framework\Assert::assertAttributeContains	(		$needle,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`,
		bool	$ignoreCase = `false`,
		bool	$checkForObjectIdentity = `true`,
		bool	$checkForNonObjectIdentity = `false`
	)

static

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains a needle.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeContainsOnly()

static PHPUnit\Framework\Assert::assertAttributeContainsOnly	(	string	$type,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		?bool	$isNativeType = `null`,
		string	$message = `''`
	)

static

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object contains only values of a given type.

Parameters

object \| string	$haystackClassOrObject
bool	$isNativeType

Exceptions

ExpectationFailedException

◆ assertAttributeCount()

static PHPUnit\Framework\Assert::assertAttributeCount	(	int	$expectedCount,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`
	)

static

Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeEmpty()

static PHPUnit\Framework\Assert::assertAttributeEmpty	(	string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`
	)

static

Asserts that a static attribute of a class or an attribute of an object is empty.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeEquals()

static PHPUnit\Framework\Assert::assertAttributeEquals	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`,
		float	$delta = `0.0`,
		int	$maxDepth = `10`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that a variable is equal to an attribute of an object.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeGreaterThan()

static PHPUnit\Framework\Assert::assertAttributeGreaterThan	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is greater than another value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeGreaterThanOrEqual()

static PHPUnit\Framework\Assert::assertAttributeGreaterThanOrEqual	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is greater than or equal to another value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeInstanceOf()

static PHPUnit\Framework\Assert::assertAttributeInstanceOf	(	string	$expected,
		string	$attributeName,
			$classOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is of a given type.

Parameters

object | string $classOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeInternalType()

static PHPUnit\Framework\Assert::assertAttributeInternalType	(	string	$expected,
		string	$attributeName,
			$classOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is of a given type.

Parameters

object | string $classOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeLessThan()

static PHPUnit\Framework\Assert::assertAttributeLessThan	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is smaller than another value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeLessThanOrEqual()

static PHPUnit\Framework\Assert::assertAttributeLessThanOrEqual	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is smaller than or equal to another value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotContains()

static PHPUnit\Framework\Assert::assertAttributeNotContains	(		$needle,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`,
		bool	$ignoreCase = `false`,
		bool	$checkForObjectIdentity = `true`,
		bool	$checkForNonObjectIdentity = `false`
	)

static

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain a needle.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotContainsOnly()

static PHPUnit\Framework\Assert::assertAttributeNotContainsOnly	(	string	$type,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		?bool	$isNativeType = `null`,
		string	$message = `''`
	)

static

Asserts that a haystack that is stored in a static attribute of a class or an attribute of an object does not contain only values of a given type.

Parameters

object \| string	$haystackClassOrObject
bool	$isNativeType

Exceptions

ExpectationFailedException

◆ assertAttributeNotCount()

static PHPUnit\Framework\Assert::assertAttributeNotCount	(	int	$expectedCount,
		string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`
	)

static

Asserts the number of elements of an array, Countable or Traversable that is stored in an attribute.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotEmpty()

static PHPUnit\Framework\Assert::assertAttributeNotEmpty	(	string	$haystackAttributeName,
			$haystackClassOrObject,
		string	$message = `''`
	)

static

Asserts that a static attribute of a class or an attribute of an object is not empty.

Parameters

object | string $haystackClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotEquals()

static PHPUnit\Framework\Assert::assertAttributeNotEquals	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`,
		float	$delta = `0.0`,
		int	$maxDepth = `10`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that a variable is not equal to an attribute of an object.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotInstanceOf()

static PHPUnit\Framework\Assert::assertAttributeNotInstanceOf	(	string	$expected,
		string	$attributeName,
			$classOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is of a given type.

Parameters

object | string $classOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotInternalType()

static PHPUnit\Framework\Assert::assertAttributeNotInternalType	(	string	$expected,
		string	$attributeName,
			$classOrObject,
		string	$message = `''`
	)

static

Asserts that an attribute is of a given type.

Parameters

object | string $classOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeNotSame()

static PHPUnit\Framework\Assert::assertAttributeNotSame	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that a variable and an attribute of an object do not have the same type and value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertAttributeSame()

static PHPUnit\Framework\Assert::assertAttributeSame	(		$expected,
		string	$actualAttributeName,
			$actualClassOrObject,
		string	$message = `''`
	)

static

Asserts that a variable and an attribute of an object have the same type and value.

Parameters

object | string $actualClassOrObject

Exceptions

ExpectationFailedException

◆ assertClassHasAttribute()

static PHPUnit\Framework\Assert::assertClassHasAttribute	(	string	$attributeName,
		string	$className,
		string	$message = `''`
	)

static

Asserts that a class has a specified attribute.

Exceptions

ExpectationFailedException

◆ assertClassHasStaticAttribute()

static PHPUnit\Framework\Assert::assertClassHasStaticAttribute	(	string	$attributeName,
		string	$className,
		string	$message = `''`
	)

static

Asserts that a class has a specified static attribute.

Exceptions

ExpectationFailedException

◆ assertClassNotHasAttribute()

static PHPUnit\Framework\Assert::assertClassNotHasAttribute	(	string	$attributeName,
		string	$className,
		string	$message = `''`
	)

static

Asserts that a class does not have a specified attribute.

Exceptions

ExpectationFailedException

◆ assertClassNotHasStaticAttribute()

static PHPUnit\Framework\Assert::assertClassNotHasStaticAttribute	(	string	$attributeName,
		string	$className,
		string	$message = `''`
	)

static

Asserts that a class does not have a specified static attribute.

Exceptions

ExpectationFailedException

◆ assertContains()

static PHPUnit\Framework\Assert::assertContains	(		$needle,
			$haystack,
		string	$message = `''`,
		bool	$ignoreCase = `false`,
		bool	$checkForObjectIdentity = `true`,
		bool	$checkForNonObjectIdentity = `false`
	)

static

Asserts that a haystack contains a needle.

Exceptions

ExpectationFailedException

◆ assertContainsEquals()

static PHPUnit\Framework\Assert::assertContainsEquals	(		$needle,
		iterable	$haystack,
		string	$message = `''`
	)

static

◆ assertContainsOnly()

static PHPUnit\Framework\Assert::assertContainsOnly	(	string	$type,
		iterable	$haystack,
		?bool	$isNativeType = `null`,
		string	$message = `''`
	)

static

Asserts that a haystack contains only values of a given type.

Exceptions

ExpectationFailedException

◆ assertContainsOnlyInstancesOf()

static PHPUnit\Framework\Assert::assertContainsOnlyInstancesOf	(	string	$className,
		iterable	$haystack,
		string	$message = `''`
	)

static

Asserts that a haystack contains only instances of a given class name.

Exceptions

ExpectationFailedException

◆ assertCount()

static PHPUnit\Framework\Assert::assertCount	(	int	$expectedCount,
			$haystack,
		string	$message = `''`
	)

static

Asserts the number of elements of an array, Countable or Traversable.

Parameters

Countable | iterable $haystack

Exceptions

ExpectationFailedException

◆ assertDirectoryExists()

static PHPUnit\Framework\Assert::assertDirectoryExists	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory exists.

Exceptions

ExpectationFailedException

◆ assertDirectoryIsReadable()

static PHPUnit\Framework\Assert::assertDirectoryIsReadable	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory exists and is readable.

Exceptions

ExpectationFailedException

◆ assertDirectoryIsWritable()

static PHPUnit\Framework\Assert::assertDirectoryIsWritable	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory exists and is writable.

Exceptions

ExpectationFailedException

◆ assertDirectoryNotExists()

static PHPUnit\Framework\Assert::assertDirectoryNotExists	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory does not exist.

Exceptions

ExpectationFailedException

◆ assertDirectoryNotIsReadable()

static PHPUnit\Framework\Assert::assertDirectoryNotIsReadable	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory exists and is not readable.

Exceptions

ExpectationFailedException

◆ assertDirectoryNotIsWritable()

static PHPUnit\Framework\Assert::assertDirectoryNotIsWritable	(	string	$directory,
		string	$message = `''`
	)

static

Asserts that a directory exists and is not writable.

Exceptions

ExpectationFailedException

◆ assertEmpty()

static PHPUnit\Framework\Assert::assertEmpty	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is empty.

Exceptions

ExpectationFailedException

◆ assertEquals()

static PHPUnit\Framework\Assert::assertEquals	(		$expected,
			$actual,
		string	$message = `''`,
		float	$delta = `0.0`,
		int	$maxDepth = `10`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that two variables are equal.

Exceptions

ExpectationFailedException

◆ assertEqualsCanonicalizing()

static PHPUnit\Framework\Assert::assertEqualsCanonicalizing	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables are equal (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertEqualsIgnoringCase()

static PHPUnit\Framework\Assert::assertEqualsIgnoringCase	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables are equal (ignoring case).

Exceptions

ExpectationFailedException

◆ assertEqualsWithDelta()

static PHPUnit\Framework\Assert::assertEqualsWithDelta	(		$expected,
			$actual,
		float	$delta,
		string	$message = `''`
	)

static

Asserts that two variables are equal (with delta).

Exceptions

ExpectationFailedException

◆ assertEqualXMLStructure()

static PHPUnit\Framework\Assert::assertEqualXMLStructure	(	DOMElement	$expectedElement,
		DOMElement	$actualElement,
		bool	$checkAttributes = `false`,
		string	$message = `''`
	)

static

Asserts that a hierarchy of DOMElements matches.

Exceptions

AssertionFailedError
ExpectationFailedException

◆ assertFalse()

static PHPUnit\Framework\Assert::assertFalse	(		$condition,
		string	$message = `''`
	)

static

Asserts that a condition is false.

Exceptions

ExpectationFailedException

◆ assertFileEquals()

static PHPUnit\Framework\Assert::assertFileEquals	(	string	$expected,
		string	$actual,
		string	$message = `''`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that the contents of one file is equal to the contents of another file.

Exceptions

ExpectationFailedException

◆ assertFileEqualsCanonicalizing()

static PHPUnit\Framework\Assert::assertFileEqualsCanonicalizing	(	string	$expected,
		string	$actual,
		string	$message = `''`
	)

static

Asserts that the contents of one file is equal to the contents of another file (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertFileEqualsIgnoringCase()

static PHPUnit\Framework\Assert::assertFileEqualsIgnoringCase	(	string	$expected,
		string	$actual,
		string	$message = `''`
	)

static

Asserts that the contents of one file is equal to the contents of another file (ignoring case).

Exceptions

ExpectationFailedException

◆ assertFileExists()

static PHPUnit\Framework\Assert::assertFileExists	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file exists.

Exceptions

ExpectationFailedException

◆ assertFileIsReadable()

static PHPUnit\Framework\Assert::assertFileIsReadable	(	string	$file,
		string	$message = `''`
	)

static

Asserts that a file exists and is readable.

Exceptions

ExpectationFailedException

◆ assertFileIsWritable()

static PHPUnit\Framework\Assert::assertFileIsWritable	(	string	$file,
		string	$message = `''`
	)

static

Asserts that a file exists and is writable.

Exceptions

ExpectationFailedException

◆ assertFileNotEquals()

static PHPUnit\Framework\Assert::assertFileNotEquals	(	string	$expected,
		string	$actual,
		string	$message = `''`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that the contents of one file is not equal to the contents of another file.

Exceptions

ExpectationFailedException

◆ assertFileNotEqualsCanonicalizing()

static PHPUnit\Framework\Assert::assertFileNotEqualsCanonicalizing	(	string	$expected,
		string	$actual,
		string	$message = `''`
	)

static

Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertFileNotEqualsIgnoringCase()

static PHPUnit\Framework\Assert::assertFileNotEqualsIgnoringCase	(	string	$expected,
		string	$actual,
		string	$message = `''`
	)

static

Asserts that the contents of one file is not equal to the contents of another file (ignoring case).

Exceptions

ExpectationFailedException

◆ assertFileNotExists()

static PHPUnit\Framework\Assert::assertFileNotExists	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file does not exist.

Exceptions

ExpectationFailedException

◆ assertFileNotIsReadable()

static PHPUnit\Framework\Assert::assertFileNotIsReadable	(	string	$file,
		string	$message = `''`
	)

static

Asserts that a file exists and is not readable.

Exceptions

ExpectationFailedException

◆ assertFileNotIsWritable()

static PHPUnit\Framework\Assert::assertFileNotIsWritable	(	string	$file,
		string	$message = `''`
	)

static

Asserts that a file exists and is not writable.

Exceptions

ExpectationFailedException

◆ assertFinite()

static PHPUnit\Framework\Assert::assertFinite	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is finite.

Exceptions

ExpectationFailedException

◆ assertGreaterThan()

static PHPUnit\Framework\Assert::assertGreaterThan	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a value is greater than another value.

Exceptions

ExpectationFailedException

◆ assertGreaterThanOrEqual()

static PHPUnit\Framework\Assert::assertGreaterThanOrEqual	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a value is greater than or equal to another value.

Exceptions

ExpectationFailedException

◆ assertInfinite()

static PHPUnit\Framework\Assert::assertInfinite	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is infinite.

Exceptions

ExpectationFailedException

◆ assertInstanceOf()

static PHPUnit\Framework\Assert::assertInstanceOf	(	string	$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of a given type.

Exceptions

ExpectationFailedException

◆ assertInternalType()

static PHPUnit\Framework\Assert::assertInternalType	(	string	$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of a given type.

Exceptions

ExpectationFailedException

◆ assertIsArray()

static PHPUnit\Framework\Assert::assertIsArray	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type array.

Exceptions

ExpectationFailedException

◆ assertIsBool()

static PHPUnit\Framework\Assert::assertIsBool	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type bool.

Exceptions

ExpectationFailedException

◆ assertIsCallable()

static PHPUnit\Framework\Assert::assertIsCallable	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type callable.

Exceptions

ExpectationFailedException

◆ assertIsFloat()

static PHPUnit\Framework\Assert::assertIsFloat	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type float.

Exceptions

ExpectationFailedException

◆ assertIsInt()

static PHPUnit\Framework\Assert::assertIsInt	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type int.

Exceptions

ExpectationFailedException

◆ assertIsIterable()

static PHPUnit\Framework\Assert::assertIsIterable	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type iterable.

Exceptions

ExpectationFailedException

◆ assertIsNotArray()

static PHPUnit\Framework\Assert::assertIsNotArray	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type array.

Exceptions

ExpectationFailedException

◆ assertIsNotBool()

static PHPUnit\Framework\Assert::assertIsNotBool	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type bool.

Exceptions

ExpectationFailedException

◆ assertIsNotCallable()

static PHPUnit\Framework\Assert::assertIsNotCallable	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type callable.

Exceptions

ExpectationFailedException

◆ assertIsNotFloat()

static PHPUnit\Framework\Assert::assertIsNotFloat	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type float.

Exceptions

ExpectationFailedException

◆ assertIsNotInt()

static PHPUnit\Framework\Assert::assertIsNotInt	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type int.

Exceptions

ExpectationFailedException

◆ assertIsNotIterable()

static PHPUnit\Framework\Assert::assertIsNotIterable	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type iterable.

Exceptions

ExpectationFailedException

◆ assertIsNotNumeric()

static PHPUnit\Framework\Assert::assertIsNotNumeric	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type numeric.

Exceptions

ExpectationFailedException

◆ assertIsNotObject()

static PHPUnit\Framework\Assert::assertIsNotObject	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type object.

Exceptions

ExpectationFailedException

◆ assertIsNotResource()

static PHPUnit\Framework\Assert::assertIsNotResource	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type resource.

Exceptions

ExpectationFailedException

◆ assertIsNotScalar()

static PHPUnit\Framework\Assert::assertIsNotScalar	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type scalar.

Exceptions

ExpectationFailedException

◆ assertIsNotString()

static PHPUnit\Framework\Assert::assertIsNotString	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of type string.

Exceptions

ExpectationFailedException

◆ assertIsNumeric()

static PHPUnit\Framework\Assert::assertIsNumeric	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type numeric.

Exceptions

ExpectationFailedException

◆ assertIsObject()

static PHPUnit\Framework\Assert::assertIsObject	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type object.

Exceptions

ExpectationFailedException

◆ assertIsReadable()

static PHPUnit\Framework\Assert::assertIsReadable	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file/dir is readable.

Exceptions

ExpectationFailedException

◆ assertIsResource()

static PHPUnit\Framework\Assert::assertIsResource	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type resource.

Exceptions

ExpectationFailedException

◆ assertIsScalar()

static PHPUnit\Framework\Assert::assertIsScalar	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type scalar.

Exceptions

ExpectationFailedException

◆ assertIsString()

static PHPUnit\Framework\Assert::assertIsString	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is of type string.

Exceptions

ExpectationFailedException

◆ assertIsWritable()

static PHPUnit\Framework\Assert::assertIsWritable	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file/dir exists and is writable.

Exceptions

ExpectationFailedException

◆ assertJson()

static PHPUnit\Framework\Assert::assertJson	(	string	$actualJson,
		string	$message = `''`
	)

static

Asserts that a string is a valid JSON string.

Exceptions

ExpectationFailedException

◆ assertJsonFileEqualsJsonFile()

static PHPUnit\Framework\Assert::assertJsonFileEqualsJsonFile	(	string	$expectedFile,
		string	$actualFile,
		string	$message = `''`
	)

static

Asserts that two JSON files are equal.

Exceptions

ExpectationFailedException

◆ assertJsonFileNotEqualsJsonFile()

static PHPUnit\Framework\Assert::assertJsonFileNotEqualsJsonFile	(	string	$expectedFile,
		string	$actualFile,
		string	$message = `''`
	)

static

Asserts that two JSON files are not equal.

Exceptions

ExpectationFailedException

◆ assertJsonStringEqualsJsonFile()

static PHPUnit\Framework\Assert::assertJsonStringEqualsJsonFile	(	string	$expectedFile,
		string	$actualJson,
		string	$message = `''`
	)

static

Asserts that the generated JSON encoded object and the content of the given file are equal.

Exceptions

ExpectationFailedException

◆ assertJsonStringEqualsJsonString()

static PHPUnit\Framework\Assert::assertJsonStringEqualsJsonString	(	string	$expectedJson,
		string	$actualJson,
		string	$message = `''`
	)

static

Asserts that two given JSON encoded objects or arrays are equal.

Exceptions

ExpectationFailedException

◆ assertJsonStringNotEqualsJsonFile()

static PHPUnit\Framework\Assert::assertJsonStringNotEqualsJsonFile	(	string	$expectedFile,
		string	$actualJson,
		string	$message = `''`
	)

static

Asserts that the generated JSON encoded object and the content of the given file are not equal.

Exceptions

ExpectationFailedException

◆ assertJsonStringNotEqualsJsonString()

static PHPUnit\Framework\Assert::assertJsonStringNotEqualsJsonString	(		$expectedJson,
			$actualJson,
		string	$message = `''`
	)

static

Asserts that two given JSON encoded objects or arrays are not equal.

Parameters

string	$expectedJson
string	$actualJson

Exceptions

ExpectationFailedException

◆ assertLessThan()

static PHPUnit\Framework\Assert::assertLessThan	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a value is smaller than another value.

Exceptions

ExpectationFailedException

◆ assertLessThanOrEqual()

static PHPUnit\Framework\Assert::assertLessThanOrEqual	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a value is smaller than or equal to another value.

Exceptions

ExpectationFailedException

◆ assertNan()

static PHPUnit\Framework\Assert::assertNan	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is nan.

Exceptions

ExpectationFailedException

◆ assertNotContains()

static PHPUnit\Framework\Assert::assertNotContains	(		$needle,
			$haystack,
		string	$message = `''`,
		bool	$ignoreCase = `false`,
		bool	$checkForObjectIdentity = `true`,
		bool	$checkForNonObjectIdentity = `false`
	)

static

Asserts that a haystack does not contain a needle.

Exceptions

ExpectationFailedException

◆ assertNotContainsEquals()

static PHPUnit\Framework\Assert::assertNotContainsEquals	(		$needle,
		iterable	$haystack,
		string	$message = `''`
	)

static

◆ assertNotContainsOnly()

static PHPUnit\Framework\Assert::assertNotContainsOnly	(	string	$type,
		iterable	$haystack,
		?bool	$isNativeType = `null`,
		string	$message = `''`
	)

static

Asserts that a haystack does not contain only values of a given type.

Exceptions

ExpectationFailedException

◆ assertNotCount()

static PHPUnit\Framework\Assert::assertNotCount	(	int	$expectedCount,
			$haystack,
		string	$message = `''`
	)

static

Asserts the number of elements of an array, Countable or Traversable.

Parameters

Countable | iterable $haystack

Exceptions

ExpectationFailedException

◆ assertNotEmpty()

static PHPUnit\Framework\Assert::assertNotEmpty	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not empty.

Exceptions

ExpectationFailedException

◆ assertNotEquals()

static PHPUnit\Framework\Assert::assertNotEquals	(		$expected,
			$actual,
		string	$message = `''`,
			$delta = `0.0`,
			$maxDepth = `10`,
			$canonicalize = `false`,
			$ignoreCase = `false`
	)

static

Asserts that two variables are not equal.

Parameters

float	$delta
int	$maxDepth
bool	$canonicalize
bool	$ignoreCase

Exceptions

ExpectationFailedException

◆ assertNotEqualsCanonicalizing()

static PHPUnit\Framework\Assert::assertNotEqualsCanonicalizing	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables are not equal (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertNotEqualsIgnoringCase()

static PHPUnit\Framework\Assert::assertNotEqualsIgnoringCase	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables are not equal (ignoring case).

Exceptions

ExpectationFailedException

◆ assertNotEqualsWithDelta()

static PHPUnit\Framework\Assert::assertNotEqualsWithDelta	(		$expected,
			$actual,
		float	$delta,
		string	$message = `''`
	)

static

Asserts that two variables are not equal (with delta).

Exceptions

ExpectationFailedException

◆ assertNotFalse()

static PHPUnit\Framework\Assert::assertNotFalse	(		$condition,
		string	$message = `''`
	)

static

Asserts that a condition is not false.

Exceptions

ExpectationFailedException

◆ assertNotInstanceOf()

static PHPUnit\Framework\Assert::assertNotInstanceOf	(	string	$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of a given type.

Exceptions

ExpectationFailedException

◆ assertNotInternalType()

static PHPUnit\Framework\Assert::assertNotInternalType	(	string	$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not of a given type.

Exceptions

ExpectationFailedException

◆ assertNotIsReadable()

static PHPUnit\Framework\Assert::assertNotIsReadable	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file/dir exists and is not readable.

Exceptions

ExpectationFailedException

◆ assertNotIsWritable()

static PHPUnit\Framework\Assert::assertNotIsWritable	(	string	$filename,
		string	$message = `''`
	)

static

Asserts that a file/dir exists and is not writable.

Exceptions

ExpectationFailedException

◆ assertNotNull()

static PHPUnit\Framework\Assert::assertNotNull	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is not null.

Exceptions

ExpectationFailedException

◆ assertNotRegExp()

static PHPUnit\Framework\Assert::assertNotRegExp	(	string	$pattern,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string does not match a given regular expression.

Exceptions

ExpectationFailedException

◆ assertNotSame()

static PHPUnit\Framework\Assert::assertNotSame	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables do not have the same type and value. Used on objects, it asserts that two variables do not reference the same object.

Exceptions

ExpectationFailedException

◆ assertNotSameSize()

static PHPUnit\Framework\Assert::assertNotSameSize	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Assert that the size of two arrays (or Countable or Traversable objects) is not the same.

Parameters

Countable \| iterable	$expected
Countable \| iterable	$actual

Exceptions

ExpectationFailedException

◆ assertNotTrue()

static PHPUnit\Framework\Assert::assertNotTrue	(		$condition,
		string	$message = `''`
	)

static

Asserts that a condition is not true.

Exceptions

ExpectationFailedException

◆ assertNull()

static PHPUnit\Framework\Assert::assertNull	(		$actual,
		string	$message = `''`
	)

static

Asserts that a variable is null.

Exceptions

ExpectationFailedException

◆ assertObjectHasAttribute()

static PHPUnit\Framework\Assert::assertObjectHasAttribute	(	string	$attributeName,
			$object,
		string	$message = `''`
	)

static

Asserts that an object has a specified attribute.

Parameters

object $object

Exceptions

ExpectationFailedException

◆ assertObjectNotHasAttribute()

static PHPUnit\Framework\Assert::assertObjectNotHasAttribute	(	string	$attributeName,
			$object,
		string	$message = `''`
	)

static

Asserts that an object does not have a specified attribute.

Parameters

object $object

Exceptions

ExpectationFailedException

◆ assertRegExp()

static PHPUnit\Framework\Assert::assertRegExp	(	string	$pattern,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string matches a given regular expression.

Exceptions

ExpectationFailedException

◆ assertSame()

static PHPUnit\Framework\Assert::assertSame	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object.

Exceptions

ExpectationFailedException

◆ assertSameSize()

static PHPUnit\Framework\Assert::assertSameSize	(		$expected,
			$actual,
		string	$message = `''`
	)

static

Assert that the size of two arrays (or Countable or Traversable objects) is the same.

Parameters

Countable \| iterable	$expected
Countable \| iterable	$actual

Exceptions

ExpectationFailedException

◆ assertStringContainsString()

static PHPUnit\Framework\Assert::assertStringContainsString	(	string	$needle,
		string	$haystack,
		string	$message = `''`
	)

static

Exceptions

ExpectationFailedException

◆ assertStringContainsStringIgnoringCase()

static PHPUnit\Framework\Assert::assertStringContainsStringIgnoringCase	(	string	$needle,
		string	$haystack,
		string	$message = `''`
	)

static

Exceptions

ExpectationFailedException

◆ assertStringEndsNotWith()

static PHPUnit\Framework\Assert::assertStringEndsNotWith	(	string	$suffix,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string ends not with a given suffix.

Exceptions

ExpectationFailedException

◆ assertStringEndsWith()

static PHPUnit\Framework\Assert::assertStringEndsWith	(	string	$suffix,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string ends with a given suffix.

Exceptions

ExpectationFailedException

◆ assertStringEqualsFile()

static PHPUnit\Framework\Assert::assertStringEqualsFile	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that the contents of a string is equal to the contents of a file.

Exceptions

ExpectationFailedException

◆ assertStringEqualsFileCanonicalizing()

static PHPUnit\Framework\Assert::assertStringEqualsFileCanonicalizing	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`
	)

static

Asserts that the contents of a string is equal to the contents of a file (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertStringEqualsFileIgnoringCase()

static PHPUnit\Framework\Assert::assertStringEqualsFileIgnoringCase	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`
	)

static

Asserts that the contents of a string is equal to the contents of a file (ignoring case).

Exceptions

ExpectationFailedException

◆ assertStringMatchesFormat()

static PHPUnit\Framework\Assert::assertStringMatchesFormat	(	string	$format,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string matches a given format string.

Exceptions

ExpectationFailedException

◆ assertStringMatchesFormatFile()

static PHPUnit\Framework\Assert::assertStringMatchesFormatFile	(	string	$formatFile,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string matches a given format file.

Exceptions

ExpectationFailedException

◆ assertStringNotContainsString()

static PHPUnit\Framework\Assert::assertStringNotContainsString	(	string	$needle,
		string	$haystack,
		string	$message = `''`
	)

static

Exceptions

ExpectationFailedException

◆ assertStringNotContainsStringIgnoringCase()

static PHPUnit\Framework\Assert::assertStringNotContainsStringIgnoringCase	(	string	$needle,
		string	$haystack,
		string	$message = `''`
	)

static

Exceptions

ExpectationFailedException

◆ assertStringNotEqualsFile()

static PHPUnit\Framework\Assert::assertStringNotEqualsFile	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Asserts that the contents of a string is not equal to the contents of a file.

Exceptions

ExpectationFailedException

◆ assertStringNotEqualsFileCanonicalizing()

static PHPUnit\Framework\Assert::assertStringNotEqualsFileCanonicalizing	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`
	)

static

Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).

Exceptions

ExpectationFailedException

◆ assertStringNotEqualsFileIgnoringCase()

static PHPUnit\Framework\Assert::assertStringNotEqualsFileIgnoringCase	(	string	$expectedFile,
		string	$actualString,
		string	$message = `''`
	)

static

Asserts that the contents of a string is not equal to the contents of a file (ignoring case).

Exceptions

ExpectationFailedException

◆ assertStringNotMatchesFormat()

static PHPUnit\Framework\Assert::assertStringNotMatchesFormat	(	string	$format,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string does not match a given format string.

Exceptions

ExpectationFailedException

◆ assertStringNotMatchesFormatFile()

static PHPUnit\Framework\Assert::assertStringNotMatchesFormatFile	(	string	$formatFile,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string does not match a given format string.

Exceptions

ExpectationFailedException

◆ assertStringStartsNotWith()

static PHPUnit\Framework\Assert::assertStringStartsNotWith	(		$prefix,
			$string,
		string	$message = `''`
	)

static

Asserts that a string starts not with a given prefix.

Parameters

string	$prefix
string	$string

Exceptions

ExpectationFailedException

◆ assertStringStartsWith()

static PHPUnit\Framework\Assert::assertStringStartsWith	(	string	$prefix,
		string	$string,
		string	$message = `''`
	)

static

Asserts that a string starts with a given prefix.

Exceptions

ExpectationFailedException

◆ assertThat()

static PHPUnit\Framework\Assert::assertThat	(		$value,
		Constraint	$constraint,
		string	$message = `''`
	)

static

Evaluates a PHPUnit\Framework\Constraint matcher object.

Exceptions

ExpectationFailedException

◆ assertTrue()

static PHPUnit\Framework\Assert::assertTrue	(		$condition,
		string	$message = `''`
	)

static

Asserts that a condition is true.

Exceptions

ExpectationFailedException

◆ assertXmlFileEqualsXmlFile()

static PHPUnit\Framework\Assert::assertXmlFileEqualsXmlFile	(	string	$expectedFile,
		string	$actualFile,
		string	$message = `''`
	)

static

Asserts that two XML files are equal.

Exceptions

ExpectationFailedException

◆ assertXmlFileNotEqualsXmlFile()

static PHPUnit\Framework\Assert::assertXmlFileNotEqualsXmlFile	(	string	$expectedFile,
		string	$actualFile,
		string	$message = `''`
	)

static

Asserts that two XML files are not equal.

Exceptions

ExpectationFailedException

◆ assertXmlStringEqualsXmlFile()

static PHPUnit\Framework\Assert::assertXmlStringEqualsXmlFile	(	string	$expectedFile,
			$actualXml,
		string	$message = `''`
	)

static

Asserts that two XML documents are equal.

Parameters

DOMDocument | string $actualXml

Exceptions

ExpectationFailedException

◆ assertXmlStringEqualsXmlString()

static PHPUnit\Framework\Assert::assertXmlStringEqualsXmlString	(		$expectedXml,
			$actualXml,
		string	$message = `''`
	)

static

Asserts that two XML documents are equal.

Parameters

DOMDocument \| string	$expectedXml
DOMDocument \| string	$actualXml

Exceptions

ExpectationFailedException

◆ assertXmlStringNotEqualsXmlFile()

static PHPUnit\Framework\Assert::assertXmlStringNotEqualsXmlFile	(	string	$expectedFile,
			$actualXml,
		string	$message = `''`
	)

static

Asserts that two XML documents are not equal.

Parameters

DOMDocument | string $actualXml

Exceptions

ExpectationFailedException

◆ assertXmlStringNotEqualsXmlString()

static PHPUnit\Framework\Assert::assertXmlStringNotEqualsXmlString	(		$expectedXml,
			$actualXml,
		string	$message = `''`
	)

static

Asserts that two XML documents are not equal.

Parameters

DOMDocument \| string	$expectedXml
DOMDocument \| string	$actualXml

Exceptions

ExpectationFailedException

◆ attribute()

static PHPUnit\Framework\Assert::attribute	(	Constraint	$constraint,
		string	$attributeName
	)

static

Deprecated:: https://github.com/sebastianbergmann/phpunit/issues/3338 @codeCoverageIgnore

◆ attributeEqualTo()

static PHPUnit\Framework\Assert::attributeEqualTo	(	string	$attributeName,
			$value,
		float	$delta = `0.0`,
		int	$maxDepth = `10`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

Deprecated:: https://github.com/sebastianbergmann/phpunit/issues/3338 @codeCoverageIgnore

◆ callback()

static PHPUnit\Framework\Assert::callback ( callable $callback )

static

◆ classHasAttribute()

static PHPUnit\Framework\Assert::classHasAttribute ( string $attributeName )

static

◆ classHasStaticAttribute()

static PHPUnit\Framework\Assert::classHasStaticAttribute ( string $attributeName )

static

◆ contains()

static PHPUnit\Framework\Assert::contains	(		$value,
		bool	$checkForObjectIdentity = `true`,
		bool	$checkForNonObjectIdentity = `false`
	)

static

Deprecated:: Use containsEqual() or containsIdentical() instead

◆ containsEqual()

static PHPUnit\Framework\Assert::containsEqual ( $value )

static

◆ containsIdentical()

static PHPUnit\Framework\Assert::containsIdentical ( $value )

static

◆ containsOnly()

static PHPUnit\Framework\Assert::containsOnly ( string $type )

static

◆ containsOnlyInstancesOf()

static PHPUnit\Framework\Assert::containsOnlyInstancesOf ( string $className )

static

◆ countOf()

static PHPUnit\Framework\Assert::countOf ( int $count )

static

◆ directoryExists()

static PHPUnit\Framework\Assert::directoryExists ( )

static

◆ equalTo()

static PHPUnit\Framework\Assert::equalTo	(		$value,
		float	$delta = `0.0`,
		int	$maxDepth = `10`,
		bool	$canonicalize = `false`,
		bool	$ignoreCase = `false`
	)

static

◆ fail()

static PHPUnit\Framework\Assert::fail ( string $message = '' )

static

Fails a test with the given message.

Exceptions

AssertionFailedError @psalm-return never-return

◆ fileExists()

static PHPUnit\Framework\Assert::fileExists ( )

static

◆ getCount()

static PHPUnit\Framework\Assert::getCount ( )

static

Return the current assertion count.

◆ getObjectAttribute()

static PHPUnit\Framework\Assert::getObjectAttribute	(		$object,
		string	$attributeName
	)

static

Returns the value of an object's attribute. This also works for attributes that are declared protected or private.

Parameters

object $object

Exceptions

Exception

Deprecated:: https://github.com/sebastianbergmann/phpunit/issues/3338 @codeCoverageIgnore

◆ getStaticAttribute()

static PHPUnit\Framework\Assert::getStaticAttribute	(	string	$className,
		string	$attributeName
	)

static

Returns the value of a static attribute. This also works for attributes that are declared protected or private.

Exceptions

Exception

Deprecated:: https://github.com/sebastianbergmann/phpunit/issues/3338 @codeCoverageIgnore

◆ greaterThan()

static PHPUnit\Framework\Assert::greaterThan ( $value )

static

◆ greaterThanOrEqual()

static PHPUnit\Framework\Assert::greaterThanOrEqual ( $value )

static

◆ identicalTo()

static PHPUnit\Framework\Assert::identicalTo ( $value )

static

◆ isEmpty()

static PHPUnit\Framework\Assert::isEmpty ( )

static

◆ isFalse()

static PHPUnit\Framework\Assert::isFalse ( )

static

◆ isFinite()

static PHPUnit\Framework\Assert::isFinite ( )

static

◆ isInfinite()

static PHPUnit\Framework\Assert::isInfinite ( )

static

◆ isInstanceOf()

static PHPUnit\Framework\Assert::isInstanceOf ( string $className )

static

◆ isJson()

static PHPUnit\Framework\Assert::isJson ( )

static

◆ isNan()

static PHPUnit\Framework\Assert::isNan ( )

static

◆ isNull()

static PHPUnit\Framework\Assert::isNull ( )

static

◆ isReadable()

static PHPUnit\Framework\Assert::isReadable ( )

static

◆ isTrue()

static PHPUnit\Framework\Assert::isTrue ( )

static

◆ isType()

static PHPUnit\Framework\Assert::isType ( string $type )

static

◆ isWritable()

static PHPUnit\Framework\Assert::isWritable ( )

static

◆ lessThan()

static PHPUnit\Framework\Assert::lessThan ( $value )

static

◆ lessThanOrEqual()

static PHPUnit\Framework\Assert::lessThanOrEqual ( $value )

static

◆ logicalAnd()

static PHPUnit\Framework\Assert::logicalAnd ( )

static

Exceptions

Exception

◆ logicalNot()

static PHPUnit\Framework\Assert::logicalNot ( Constraint $constraint )

static

◆ logicalOr()

static PHPUnit\Framework\Assert::logicalOr ( )

static

◆ logicalXor()

static PHPUnit\Framework\Assert::logicalXor ( )

static

◆ markTestIncomplete()

static PHPUnit\Framework\Assert::markTestIncomplete ( string $message = '' )

static

Mark the test as incomplete.

Exceptions

IncompleteTestError @psalm-return never-return

◆ markTestSkipped()

static PHPUnit\Framework\Assert::markTestSkipped ( string $message = '' )

static

Mark the test as skipped.

Exceptions

SkippedTestError
SyntheticSkippedError	@psalm-return never-return

◆ matches()

static PHPUnit\Framework\Assert::matches ( string $string )

static

◆ matchesRegularExpression()

static PHPUnit\Framework\Assert::matchesRegularExpression ( string $pattern )

static

◆ objectHasAttribute()

static PHPUnit\Framework\Assert::objectHasAttribute ( $attributeName )

static

◆ readAttribute()

static PHPUnit\Framework\Assert::readAttribute	(		$classOrObject,
		string	$attributeName
	)

static

Returns the value of an attribute of a class or an object. This also works for attributes that are declared protected or private.

Parameters

object | string $classOrObject

Exceptions

Exception

Deprecated:: https://github.com/sebastianbergmann/phpunit/issues/3338 @codeCoverageIgnore

◆ resetCount()

static PHPUnit\Framework\Assert::resetCount ( )

static

Reset the assertion counter.

◆ stringContains()

static PHPUnit\Framework\Assert::stringContains	(	string	$string,
		bool	$case = `true`
	)

static

◆ stringEndsWith()

static PHPUnit\Framework\Assert::stringEndsWith ( string $suffix )

static

◆ stringStartsWith()

static PHPUnit\Framework\Assert::stringStartsWith ( $prefix )

static

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

vendor/phpunit/phpunit/src/Framework/Assert.php

Detailed Description

Static Public Member Functions

Member Function Documentation

◆ anything()

◆ arrayHasKey()

◆ assertArrayHasKey()

◆ assertArrayNotHasKey()

◆ assertArraySubset()

◆ assertAttributeContains()

◆ assertAttributeContainsOnly()

◆ assertAttributeCount()

◆ assertAttributeEmpty()

◆ assertAttributeEquals()

◆ assertAttributeGreaterThan()

◆ assertAttributeGreaterThanOrEqual()

◆ assertAttributeInstanceOf()

◆ assertAttributeInternalType()

◆ assertAttributeLessThan()

◆ assertAttributeLessThanOrEqual()

◆ assertAttributeNotContains()

◆ assertAttributeNotContainsOnly()

◆ assertAttributeNotCount()

◆ assertAttributeNotEmpty()

◆ assertAttributeNotEquals()

◆ assertAttributeNotInstanceOf()

◆ assertAttributeNotInternalType()

◆ assertAttributeNotSame()

◆ assertAttributeSame()

◆ assertClassHasAttribute()

◆ assertClassHasStaticAttribute()

◆ assertClassNotHasAttribute()

◆ assertClassNotHasStaticAttribute()

◆ assertContains()

◆ assertContainsEquals()

◆ assertContainsOnly()

◆ assertContainsOnlyInstancesOf()

◆ assertCount()

◆ assertDirectoryExists()

◆ assertDirectoryIsReadable()

◆ assertDirectoryIsWritable()

◆ assertDirectoryNotExists()

◆ assertDirectoryNotIsReadable()

◆ assertDirectoryNotIsWritable()

◆ assertEmpty()

◆ assertEquals()

◆ assertEqualsCanonicalizing()

◆ assertEqualsIgnoringCase()

◆ assertEqualsWithDelta()

◆ assertEqualXMLStructure()

◆ assertFalse()

◆ assertFileEquals()

◆ assertFileEqualsCanonicalizing()

◆ assertFileEqualsIgnoringCase()

◆ assertFileExists()

◆ assertFileIsReadable()

◆ assertFileIsWritable()

◆ assertFileNotEquals()

◆ assertFileNotEqualsCanonicalizing()

◆ assertFileNotEqualsIgnoringCase()

◆ assertFileNotExists()

◆ assertFileNotIsReadable()

◆ assertFileNotIsWritable()

◆ assertFinite()

◆ assertGreaterThan()

◆ assertGreaterThanOrEqual()

◆ assertInfinite()

◆ assertInstanceOf()

◆ assertInternalType()

◆ assertIsArray()

◆ assertIsBool()

◆ assertIsCallable()

◆ assertIsFloat()

◆ assertIsInt()

◆ assertIsIterable()

◆ assertIsNotArray()

◆ assertIsNotBool()

◆ assertIsNotCallable()

◆ assertIsNotFloat()

◆ assertIsNotInt()

◆ assertIsNotIterable()