TestCase
extends Assert
in package
implements
Reorderable, SelfDescribing, Test
Tags
Table of Contents
Interfaces
- Reorderable
- SelfDescribing
- Test
Constants
- LOCALE_CATEGORIES = [\LC_ALL, \LC_COLLATE, \LC_CTYPE, \LC_MONETARY, \LC_NUMERIC, \LC_TIME]
Properties
- $backupGlobals : bool|null
- $backupGlobalsExcludeList : array<string|int, mixed>
- $backupStaticProperties : bool|null
- $backupStaticPropertiesExcludeList : array<string|int, mixed>
- $count : int
- $customComparators : array<string|int, mixed>
- $data : array<string|int, mixed>
- $dataName : int|string
- $dependencies : array<string|int, mixed>
- $dependencyInput : array<string|int, mixed>
- $doesNotPerformAssertions : bool
- $expectedException : string|null
- $expectedExceptionCode : null|int|string
- $expectedExceptionMessage : string|null
- $expectedExceptionMessageRegExp : string|null
- $failureTypes : array<string|int, mixed>
- $groups : array<string|int, mixed>
- $iniSettings : array<string|int, mixed>
- $inIsolation : bool
- $locale : array<string|int, mixed>
- $mockObjects : array<string|int, mixed>
- $name : string
- $numberOfAssertionsPerformed : int
- $output : string
- $outputBufferingActive : bool
- $outputBufferingLevel : int
- $outputExpectedRegex : string|null
- $outputExpectedString : string|null
- $outputRetrievedForAssertion : bool
- $preserveGlobalState : bool
- $providedTests : array<string|int, mixed>
- $registerMockObjectsFromTestArgumentsRecursively : bool
- $runClassInSeparateProcess : bool|null
- $runTestInSeparateProcess : bool|null
- $snapshot : Snapshot|null
- $status : TestStatus
- $testResult : mixed
- $testValueObjectForEvents : TestMethod|null
- $wasPrepared : bool
Methods
- any() : AnyInvokedCount
- Returns a matcher that matches when the method is executed zero or more times.
- anything() : IsAnything
- arrayHasKey() : ArrayHasKey
- assertArrayHasKey() : void
- Asserts that an array has a specified key.
- assertArrayNotHasKey() : void
- Asserts that an array does not have a specified key.
- assertContains() : void
- Asserts that a haystack contains a needle.
- assertContainsEquals() : void
- assertContainsOnly() : void
- Asserts that a haystack contains only values of a given type.
- assertContainsOnlyInstancesOf() : void
- Asserts that a haystack contains only instances of a given class name.
- assertCount() : void
- Asserts the number of elements of an array, Countable or Traversable.
- assertDirectoryDoesNotExist() : void
- Asserts that a directory does not exist.
- assertDirectoryExists() : void
- Asserts that a directory exists.
- assertDirectoryIsNotReadable() : void
- Asserts that a directory exists and is not readable.
- assertDirectoryIsNotWritable() : void
- Asserts that a directory exists and is not writable.
- assertDirectoryIsReadable() : void
- Asserts that a directory exists and is readable.
- assertDirectoryIsWritable() : void
- Asserts that a directory exists and is writable.
- assertDoesNotMatchRegularExpression() : void
- Asserts that a string does not match a given regular expression.
- assertEmpty() : void
- Asserts that a variable is empty.
- assertEquals() : void
- Asserts that two variables are equal.
- assertEqualsCanonicalizing() : void
- Asserts that two variables are equal (canonicalizing).
- assertEqualsIgnoringCase() : void
- Asserts that two variables are equal (ignoring case).
- assertEqualsWithDelta() : void
- Asserts that two variables are equal (with delta).
- assertFalse() : void
- Asserts that a condition is false.
- assertFileDoesNotExist() : void
- Asserts that a file does not exist.
- assertFileEquals() : void
- Asserts that the contents of one file is equal to the contents of another file.
- assertFileEqualsCanonicalizing() : void
- Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
- assertFileEqualsIgnoringCase() : void
- Asserts that the contents of one file is equal to the contents of another file (ignoring case).
- assertFileExists() : void
- Asserts that a file exists.
- assertFileIsNotReadable() : void
- Asserts that a file exists and is not readable.
- assertFileIsNotWritable() : void
- Asserts that a file exists and is not writable.
- assertFileIsReadable() : void
- Asserts that a file exists and is readable.
- assertFileIsWritable() : void
- Asserts that a file exists and is writable.
- assertFileMatchesFormat() : void
- Asserts that a string matches a given format string.
- assertFileMatchesFormatFile() : void
- Asserts that a string matches a given format string.
- assertFileNotEquals() : void
- Asserts that the contents of one file is not equal to the contents of another file.
- assertFileNotEqualsCanonicalizing() : void
- Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
- assertFileNotEqualsIgnoringCase() : void
- Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
- assertFinite() : void
- Asserts that a variable is finite.
- assertGreaterThan() : void
- Asserts that a value is greater than another value.
- assertGreaterThanOrEqual() : void
- Asserts that a value is greater than or equal to another value.
- assertInfinite() : void
- Asserts that a variable is infinite.
- assertInstanceOf() : void
- Asserts that a variable is of a given type.
- assertIsArray() : void
- Asserts that a variable is of type array.
- assertIsBool() : void
- Asserts that a variable is of type bool.
- assertIsCallable() : void
- Asserts that a variable is of type callable.
- assertIsClosedResource() : void
- Asserts that a variable is of type resource and is closed.
- assertIsFloat() : void
- Asserts that a variable is of type float.
- assertIsInt() : void
- Asserts that a variable is of type int.
- assertIsIterable() : void
- Asserts that a variable is of type iterable.
- assertIsList() : void
- assertIsNotArray() : void
- Asserts that a variable is not of type array.
- assertIsNotBool() : void
- Asserts that a variable is not of type bool.
- assertIsNotCallable() : void
- Asserts that a variable is not of type callable.
- assertIsNotClosedResource() : void
- Asserts that a variable is not of type resource.
- assertIsNotFloat() : void
- Asserts that a variable is not of type float.
- assertIsNotInt() : void
- Asserts that a variable is not of type int.
- assertIsNotIterable() : void
- Asserts that a variable is not of type iterable.
- assertIsNotNumeric() : void
- Asserts that a variable is not of type numeric.
- assertIsNotObject() : void
- Asserts that a variable is not of type object.
- assertIsNotReadable() : void
- Asserts that a file/dir exists and is not readable.
- assertIsNotResource() : void
- Asserts that a variable is not of type resource.
- assertIsNotScalar() : void
- Asserts that a variable is not of type scalar.
- assertIsNotString() : void
- Asserts that a variable is not of type string.
- assertIsNotWritable() : void
- Asserts that a file/dir exists and is not writable.
- assertIsNumeric() : void
- Asserts that a variable is of type numeric.
- assertIsObject() : void
- Asserts that a variable is of type object.
- assertIsReadable() : void
- Asserts that a file/dir is readable.
- assertIsResource() : void
- Asserts that a variable is of type resource.
- assertIsScalar() : void
- Asserts that a variable is of type scalar.
- assertIsString() : void
- Asserts that a variable is of type string.
- assertIsWritable() : void
- Asserts that a file/dir exists and is writable.
- assertJson() : void
- Asserts that a string is a valid JSON string.
- assertJsonFileEqualsJsonFile() : void
- Asserts that two JSON files are equal.
- assertJsonFileNotEqualsJsonFile() : void
- Asserts that two JSON files are not equal.
- assertJsonStringEqualsJsonFile() : void
- Asserts that the generated JSON encoded object and the content of the given file are equal.
- assertJsonStringEqualsJsonString() : void
- Asserts that two given JSON encoded objects or arrays are equal.
- assertJsonStringNotEqualsJsonFile() : void
- Asserts that the generated JSON encoded object and the content of the given file are not equal.
- assertJsonStringNotEqualsJsonString() : void
- Asserts that two given JSON encoded objects or arrays are not equal.
- assertLessThan() : void
- Asserts that a value is smaller than another value.
- assertLessThanOrEqual() : void
- Asserts that a value is smaller than or equal to another value.
- assertMatchesRegularExpression() : void
- Asserts that a string matches a given regular expression.
- assertNan() : void
- Asserts that a variable is nan.
- assertNotContains() : void
- Asserts that a haystack does not contain a needle.
- assertNotContainsEquals() : void
- assertNotContainsOnly() : void
- Asserts that a haystack does not contain only values of a given type.
- assertNotCount() : void
- Asserts the number of elements of an array, Countable or Traversable.
- assertNotEmpty() : void
- Asserts that a variable is not empty.
- assertNotEquals() : void
- Asserts that two variables are not equal.
- assertNotEqualsCanonicalizing() : void
- Asserts that two variables are not equal (canonicalizing).
- assertNotEqualsIgnoringCase() : void
- Asserts that two variables are not equal (ignoring case).
- assertNotEqualsWithDelta() : void
- Asserts that two variables are not equal (with delta).
- assertNotFalse() : void
- Asserts that a condition is not false.
- assertNotInstanceOf() : void
- Asserts that a variable is not of a given type.
- assertNotNull() : void
- Asserts that a variable is not null.
- assertNotSame() : void
- Asserts that two variables do not have the same type and value.
- assertNotSameSize() : void
- Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
- assertNotTrue() : void
- Asserts that a condition is not true.
- assertNull() : void
- Asserts that a variable is null.
- assertObjectEquals() : void
- assertObjectHasProperty() : void
- Asserts that an object has a specified property.
- assertObjectNotHasProperty() : void
- Asserts that an object does not have a specified property.
- assertSame() : void
- Asserts that two variables have the same type and value.
- assertSameSize() : void
- Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
- assertStringContainsString() : void
- assertStringContainsStringIgnoringCase() : void
- assertStringContainsStringIgnoringLineEndings() : void
- assertStringEndsNotWith() : void
- Asserts that a string ends not with a given suffix.
- assertStringEndsWith() : void
- Asserts that a string ends with a given suffix.
- assertStringEqualsFile() : void
- Asserts that the contents of a string is equal to the contents of a file.
- assertStringEqualsFileCanonicalizing() : void
- Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
- assertStringEqualsFileIgnoringCase() : void
- Asserts that the contents of a string is equal to the contents of a file (ignoring case).
- assertStringEqualsStringIgnoringLineEndings() : void
- Asserts that two strings are equal except for line endings.
- assertStringMatchesFormat() : void
- Asserts that a string matches a given format string.
- assertStringMatchesFormatFile() : void
- Asserts that a string matches a given format file.
- assertStringNotContainsString() : void
- assertStringNotContainsStringIgnoringCase() : void
- assertStringNotEqualsFile() : void
- Asserts that the contents of a string is not equal to the contents of a file.
- assertStringNotEqualsFileCanonicalizing() : void
- Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
- assertStringNotEqualsFileIgnoringCase() : void
- Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
- assertStringNotMatchesFormat() : void
- Asserts that a string does not match a given format string.
- assertStringNotMatchesFormatFile() : void
- Asserts that a string does not match a given format string.
- assertStringStartsNotWith() : void
- Asserts that a string starts not with a given prefix.
- assertStringStartsWith() : void
- Asserts that a string starts with a given prefix.
- assertThat() : void
- Evaluates a PHPUnit\Framework\Constraint matcher object.
- assertTrue() : void
- Asserts that a condition is true.
- assertXmlFileEqualsXmlFile() : void
- Asserts that two XML files are equal.
- assertXmlFileNotEqualsXmlFile() : void
- Asserts that two XML files are not equal.
- assertXmlStringEqualsXmlFile() : void
- Asserts that two XML documents are equal.
- assertXmlStringEqualsXmlString() : void
- Asserts that two XML documents are equal.
- assertXmlStringNotEqualsXmlFile() : void
- Asserts that two XML documents are not equal.
- assertXmlStringNotEqualsXmlString() : void
- Asserts that two XML documents are not equal.
- atLeast() : InvokedAtLeastCount
- Returns a matcher that matches when the method is executed at least N times.
- atLeastOnce() : InvokedAtLeastOnce
- Returns a matcher that matches when the method is executed at least once.
- atMost() : InvokedAtMostCount
- Returns a matcher that matches when the method is executed at most N times.
- callback() : Callback
- containsEqual() : TraversableContainsEqual
- containsIdentical() : TraversableContainsIdentical
- containsOnly() : TraversableContainsOnly
- containsOnlyInstancesOf() : TraversableContainsOnly
- countOf() : Count
- directoryExists() : DirectoryExists
- equalTo() : IsEqual
- equalToCanonicalizing() : IsEqualCanonicalizing
- equalToIgnoringCase() : IsEqualIgnoringCase
- equalToWithDelta() : IsEqualWithDelta
- exactly() : InvokedCount
- Returns a matcher that matches when the method is executed exactly $count times.
- expectException() : void
- expectExceptionCode() : void
- expectExceptionMessage() : void
- expectExceptionMessageMatches() : void
- expectExceptionObject() : void
- Sets up an expectation for an exception to be raised by the code under test.
- expectNotToPerformAssertions() : void
- expectOutputRegex() : void
- expectOutputString() : void
- fail() : never
- Fails a test with the given message.
- fileExists() : FileExists
- getActualOutputForAssertion() : string
- getCount() : int
- Return the current assertion count.
- getMockBuilder() : MockBuilder
- Returns a builder object to create mock objects using a fluent interface.
- greaterThan() : GreaterThan
- greaterThanOrEqual() : LogicalOr
- identicalTo() : IsIdentical
- isEmpty() : IsEmpty
- isFalse() : IsFalse
- isFinite() : IsFinite
- isInfinite() : IsInfinite
- isInstanceOf() : IsInstanceOf
- isJson() : IsJson
- isList() : IsList
- isNan() : IsNan
- isNull() : IsNull
- isReadable() : IsReadable
- isTrue() : IsTrue
- isType() : IsType
- isWritable() : IsWritable
- lessThan() : LessThan
- lessThanOrEqual() : LogicalOr
- logicalAnd() : LogicalAnd
- logicalNot() : LogicalNot
- logicalOr() : LogicalOr
- logicalXor() : LogicalXor
- markTestIncomplete() : never
- Mark the test as incomplete.
- markTestSkipped() : never
- Mark the test as skipped.
- matches() : StringMatchesFormatDescription
- matchesRegularExpression() : RegularExpression
- never() : InvokedCount
- Returns a matcher that matches when the method is never executed.
- objectEquals() : ObjectEquals
- once() : InvokedCount
- Returns a matcher that matches when the method is executed exactly once.
- onConsecutiveCalls() : ConsecutiveCalls
- resetCount() : void
- Reset the assertion counter.
- returnArgument() : ReturnArgument
- returnCallback() : ReturnCallback
- returnSelf() : ReturnSelf
- returnValue() : ReturnStub
- returnValueMap() : ReturnValueMap
- setUpBeforeClass() : void
- This method is called before the first test of this test class is run.
- stringContains() : StringContains
- stringEndsWith() : StringEndsWith
- stringEqualsStringIgnoringLineEndings() : StringEqualsStringIgnoringLineEndings
- stringStartsWith() : StringStartsWith
- tearDownAfterClass() : void
- This method is called after the last test of this test class is run.
- throwException() : Exception
- assertPostConditions() : void
- Performs assertions shared by all tests of a test case.
- assertPreConditions() : void
- Performs assertions shared by all tests of a test case.
- createConfiguredMock() : MockObject
- Creates (and configures) a mock object for the specified interface or class.
- createConfiguredStub() : Stub
- Creates (and configures) a test stub for the specified interface or class.
- createMock() : MockObject
- Creates a mock object for the specified interface or class.
- createMockForIntersectionOfInterfaces() : MockObject
- createPartialMock() : MockObject
- Creates a partial mock object for the specified interface or class.
- createStub() : Stub
- Creates a test stub for the specified interface or class.
- createStubForIntersectionOfInterfaces() : Stub
- createTestProxy() : MockObject
- Creates a test proxy for the specified class.
- getMockForAbstractClass() : MockObject
- Creates a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.
- getMockForTrait() : MockObject
- Creates 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.
- getMockFromWsdl() : MockObject
- Creates a mock object based on the given WSDL file.
- getObjectForTrait() : object
- Creates an object that uses the specified trait.
- iniSet() : void
- 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.
- onNotSuccessfulTest() : never
- This method is called when a test method did not execute successfully.
- registerComparator() : void
- registerFailureType() : void
- setLocale() : void
- This method is a wrapper for the setlocale() function that automatically resets the locale to its original value after the test is run.
- setUp() : void
- This method is called before each test.
- tearDown() : void
- This method is called after each test.
- transformException() : Throwable
- checkRequirements() : void
- cleanupIniSettings() : void
- cleanupLocaleSettings() : void
- compareGlobalStateSnapshotPart() : void
- compareGlobalStateSnapshots() : void
- createGlobalStateSnapshot() : Snapshot
- expectedExceptionWasNotRaised() : void
- handleDependencies() : bool
- invokeAfterClassHookMethods() : void
- invokeAfterTestHookMethods() : void
- invokeBeforeClassHookMethods() : void
- invokeBeforeTestHookMethods() : void
- invokeHookMethods() : void
- invokePostConditionHookMethods() : void
- invokePreConditionHookMethods() : void
- isCallableTestMethod() : bool
- isNativeType() : bool
- isRegisteredFailure() : bool
- markErrorForInvalidDependency() : void
- markSkippedForMissingDependency() : void
- methodDoesNotExistOrIsDeclaredInTestCase() : bool
- performAssertionsOnOutput() : void
- registerMockObjectsFromTestArguments() : void
- restoreGlobalState() : void
- shouldExceptionExpectationsBeVerified() : bool
- shouldInvocationMockerBeReset() : bool
- shouldRunInSeparateProcess() : bool
- snapshotGlobalState() : void
- startOutputBuffering() : void
- stopOutputBuffering() : bool
- unregisterCustomComparators() : void
- verifyExceptionExpectations() : void
- verifyMockObjects() : void
Constants
LOCALE_CATEGORIES
private
mixed
LOCALE_CATEGORIES
= [\LC_ALL, \LC_COLLATE, \LC_CTYPE, \LC_MONETARY, \LC_NUMERIC, \LC_TIME]
Properties
$backupGlobals
private
bool|null
$backupGlobals
= null
$backupGlobalsExcludeList
private
array<string|int, mixed>
$backupGlobalsExcludeList
= []
Tags
$backupStaticProperties
private
bool|null
$backupStaticProperties
= null
$backupStaticPropertiesExcludeList
private
array<string|int, mixed>
$backupStaticPropertiesExcludeList
= []
Tags
$count
private
static int
$count
= 0
$customComparators
private
array<string|int, mixed>
$customComparators
= []
Tags
$data
private
array<string|int, mixed>
$data
= []
$dataName
private
int|string
$dataName
= ''
$dependencies
private
array<string|int, mixed>
$dependencies
= []
Tags
$dependencyInput
private
array<string|int, mixed>
$dependencyInput
= []
$doesNotPerformAssertions
private
bool
$doesNotPerformAssertions
= false
$expectedException
private
string|null
$expectedException
= null
$expectedExceptionCode
private
null|int|string
$expectedExceptionCode
= null
$expectedExceptionMessage
private
string|null
$expectedExceptionMessage
= null
$expectedExceptionMessageRegExp
private
string|null
$expectedExceptionMessageRegExp
= null
$failureTypes
private
array<string|int, mixed>
$failureTypes
= []
Tags
$groups
private
array<string|int, mixed>
$groups
= []
Tags
$iniSettings
private
array<string|int, mixed>
$iniSettings
= []
Tags
$inIsolation
private
bool
$inIsolation
= false
$locale
private
array<string|int, mixed>
$locale
= []
$mockObjects
private
array<string|int, mixed>
$mockObjects
= []
Tags
$name
private
string
$name
Tags
$numberOfAssertionsPerformed
private
int
$numberOfAssertionsPerformed
= 0
$output
private
string
$output
= ''
$outputBufferingActive
private
bool
$outputBufferingActive
= false
$outputBufferingLevel
private
int
$outputBufferingLevel
$outputExpectedRegex
private
string|null
$outputExpectedRegex
= null
$outputExpectedString
private
string|null
$outputExpectedString
= null
$outputRetrievedForAssertion
private
bool
$outputRetrievedForAssertion
= false
$preserveGlobalState
private
bool
$preserveGlobalState
= false
$providedTests
private
array<string|int, mixed>
$providedTests
= []
Tags
$registerMockObjectsFromTestArgumentsRecursively
private
bool
$registerMockObjectsFromTestArgumentsRecursively
= false
$runClassInSeparateProcess
private
bool|null
$runClassInSeparateProcess
= null
$runTestInSeparateProcess
private
bool|null
$runTestInSeparateProcess
= null
$snapshot
private
Snapshot|null
$snapshot
= null
$status
private
TestStatus
$status
$testResult
private
mixed
$testResult
= null
$testValueObjectForEvents
private
TestMethod|null
$testValueObjectForEvents
= null
$wasPrepared
private
bool
$wasPrepared
= false
Methods
any()
Returns a matcher that matches when the method is executed zero or more times.
public
final static any() : AnyInvokedCount
Return values
AnyInvokedCountanything()
public
final static anything() : IsAnything
Return values
IsAnythingarrayHasKey()
public
final static arrayHasKey(int|string $key) : ArrayHasKey
Parameters
- $key : int|string
Return values
ArrayHasKeyassertArrayHasKey()
Asserts that an array has a specified key.
public
final static assertArrayHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
- $key : int|string
- $array : array<string|int, mixed>|ArrayAccess
- $message : string = ''
Tags
assertArrayNotHasKey()
Asserts that an array does not have a specified key.
public
final static assertArrayNotHasKey(int|string $key, array<string|int, mixed>|ArrayAccess $array[, string $message = '' ]) : void
Parameters
- $key : int|string
- $array : array<string|int, mixed>|ArrayAccess
- $message : string = ''
Tags
assertContains()
Asserts that a haystack contains a needle.
public
final static assertContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iterable<string|int, mixed>
- $message : string = ''
Tags
assertContainsEquals()
public
final static assertContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iterable<string|int, mixed>
- $message : string = ''
Tags
assertContainsOnly()
Asserts that a haystack contains only values of a given type.
public
final static assertContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
- $type : string
- $haystack : iterable<string|int, mixed>
- $isNativeType : bool|null = null
- $message : string = ''
Tags
assertContainsOnlyInstancesOf()
Asserts that a haystack contains only instances of a given class name.
public
final static assertContainsOnlyInstancesOf(string $className, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $className : string
- $haystack : iterable<string|int, mixed>
- $message : string = ''
Tags
assertCount()
Asserts the number of elements of an array, Countable or Traversable.
public
final static assertCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $expectedCount : int
- $haystack : Countable|iterable<string|int, mixed>
- $message : string = ''
Tags
assertDirectoryDoesNotExist()
Asserts that a directory does not exist.
public
final static assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDirectoryExists()
Asserts that a directory exists.
public
final static assertDirectoryExists(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDirectoryIsNotReadable()
Asserts that a directory exists and is not readable.
public
final static assertDirectoryIsNotReadable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDirectoryIsNotWritable()
Asserts that a directory exists and is not writable.
public
final static assertDirectoryIsNotWritable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDirectoryIsReadable()
Asserts that a directory exists and is readable.
public
final static assertDirectoryIsReadable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDirectoryIsWritable()
Asserts that a directory exists and is writable.
public
final static assertDirectoryIsWritable(string $directory[, string $message = '' ]) : void
Parameters
- $directory : string
- $message : string = ''
Tags
assertDoesNotMatchRegularExpression()
Asserts that a string does not match a given regular expression.
public
final static assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
assertEmpty()
Asserts that a variable is empty.
public
final static assertEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertEquals()
Asserts that two variables are equal.
public
final static assertEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertEqualsCanonicalizing()
Asserts that two variables are equal (canonicalizing).
public
final static assertEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertEqualsIgnoringCase()
Asserts that two variables are equal (ignoring case).
public
final static assertEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertEqualsWithDelta()
Asserts that two variables are equal (with delta).
public
final static assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $delta : float
- $message : string = ''
Tags
assertFalse()
Asserts that a condition is false.
public
final static assertFalse(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
assertFileDoesNotExist()
Asserts that a file does not exist.
public
final static assertFileDoesNotExist(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertFileEquals()
Asserts that the contents of one file is equal to the contents of another file.
public
final static assertFileEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFileEqualsCanonicalizing()
Asserts that the contents of one file is equal to the contents of another file (canonicalizing).
public
final static assertFileEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFileEqualsIgnoringCase()
Asserts that the contents of one file is equal to the contents of another file (ignoring case).
public
final static assertFileEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFileExists()
Asserts that a file exists.
public
final static assertFileExists(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertFileIsNotReadable()
Asserts that a file exists and is not readable.
public
final static assertFileIsNotReadable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
assertFileIsNotWritable()
Asserts that a file exists and is not writable.
public
final static assertFileIsNotWritable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
assertFileIsReadable()
Asserts that a file exists and is readable.
public
final static assertFileIsReadable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
assertFileIsWritable()
Asserts that a file exists and is writable.
public
final static assertFileIsWritable(string $file[, string $message = '' ]) : void
Parameters
- $file : string
- $message : string = ''
Tags
assertFileMatchesFormat()
Asserts that a string matches a given format string.
public
final static assertFileMatchesFormat(string $format, string $actualFile[, string $message = '' ]) : void
Parameters
- $format : string
- $actualFile : string
- $message : string = ''
Tags
assertFileMatchesFormatFile()
Asserts that a string matches a given format string.
public
final static assertFileMatchesFormatFile(string $formatFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $formatFile : string
- $actualFile : string
- $message : string = ''
Tags
assertFileNotEquals()
Asserts that the contents of one file is not equal to the contents of another file.
public
final static assertFileNotEquals(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFileNotEqualsCanonicalizing()
Asserts that the contents of one file is not equal to the contents of another file (canonicalizing).
public
final static assertFileNotEqualsCanonicalizing(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFileNotEqualsIgnoringCase()
Asserts that the contents of one file is not equal to the contents of another file (ignoring case).
public
final static assertFileNotEqualsIgnoringCase(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertFinite()
Asserts that a variable is finite.
public
final static assertFinite(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertGreaterThan()
Asserts that a value is greater than another value.
public
final static assertGreaterThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertGreaterThanOrEqual()
Asserts that a value is greater than or equal to another value.
public
final static assertGreaterThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertInfinite()
Asserts that a variable is infinite.
public
final static assertInfinite(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertInstanceOf()
Asserts that a variable is of a given type.
public
final static assertInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : mixed
- $message : string = ''
Tags
assertIsArray()
Asserts that a variable is of type array.
public
final static assertIsArray(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsBool()
Asserts that a variable is of type bool.
public
final static assertIsBool(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsCallable()
Asserts that a variable is of type callable.
public
final static assertIsCallable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsClosedResource()
Asserts that a variable is of type resource and is closed.
public
final static assertIsClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsFloat()
Asserts that a variable is of type float.
public
final static assertIsFloat(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsInt()
Asserts that a variable is of type int.
public
final static assertIsInt(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsIterable()
Asserts that a variable is of type iterable.
public
final static assertIsIterable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsList()
public
final static assertIsList(mixed $array[, string $message = '' ]) : void
Parameters
- $array : mixed
- $message : string = ''
Tags
assertIsNotArray()
Asserts that a variable is not of type array.
public
final static assertIsNotArray(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotBool()
Asserts that a variable is not of type bool.
public
final static assertIsNotBool(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotCallable()
Asserts that a variable is not of type callable.
public
final static assertIsNotCallable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotClosedResource()
Asserts that a variable is not of type resource.
public
final static assertIsNotClosedResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotFloat()
Asserts that a variable is not of type float.
public
final static assertIsNotFloat(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotInt()
Asserts that a variable is not of type int.
public
final static assertIsNotInt(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotIterable()
Asserts that a variable is not of type iterable.
public
final static assertIsNotIterable(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotNumeric()
Asserts that a variable is not of type numeric.
public
final static assertIsNotNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotObject()
Asserts that a variable is not of type object.
public
final static assertIsNotObject(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotReadable()
Asserts that a file/dir exists and is not readable.
public
final static assertIsNotReadable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertIsNotResource()
Asserts that a variable is not of type resource.
public
final static assertIsNotResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotScalar()
Asserts that a variable is not of type scalar.
public
final static assertIsNotScalar(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotString()
Asserts that a variable is not of type string.
public
final static assertIsNotString(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsNotWritable()
Asserts that a file/dir exists and is not writable.
public
final static assertIsNotWritable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertIsNumeric()
Asserts that a variable is of type numeric.
public
final static assertIsNumeric(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsObject()
Asserts that a variable is of type object.
public
final static assertIsObject(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsReadable()
Asserts that a file/dir is readable.
public
final static assertIsReadable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertIsResource()
Asserts that a variable is of type resource.
public
final static assertIsResource(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsScalar()
Asserts that a variable is of type scalar.
public
final static assertIsScalar(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsString()
Asserts that a variable is of type string.
public
final static assertIsString(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertIsWritable()
Asserts that a file/dir exists and is writable.
public
final static assertIsWritable(string $filename[, string $message = '' ]) : void
Parameters
- $filename : string
- $message : string = ''
Tags
assertJson()
Asserts that a string is a valid JSON string.
public
final static assertJson(string $actual[, string $message = '' ]) : void
Parameters
- $actual : string
- $message : string = ''
Tags
assertJsonFileEqualsJsonFile()
Asserts that two JSON files are equal.
public
final static assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
assertJsonFileNotEqualsJsonFile()
Asserts that two JSON files are not equal.
public
final static assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
assertJsonStringEqualsJsonFile()
Asserts that the generated JSON encoded object and the content of the given file are equal.
public
final static assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualJson : string
- $message : string = ''
Tags
assertJsonStringEqualsJsonString()
Asserts that two given JSON encoded objects or arrays are equal.
public
final static assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedJson : string
- $actualJson : string
- $message : string = ''
Tags
assertJsonStringNotEqualsJsonFile()
Asserts that the generated JSON encoded object and the content of the given file are not equal.
public
final static assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualJson : string
- $message : string = ''
Tags
assertJsonStringNotEqualsJsonString()
Asserts that two given JSON encoded objects or arrays are not equal.
public
final static assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson[, string $message = '' ]) : void
Parameters
- $expectedJson : string
- $actualJson : string
- $message : string = ''
Tags
assertLessThan()
Asserts that a value is smaller than another value.
public
final static assertLessThan(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertLessThanOrEqual()
Asserts that a value is smaller than or equal to another value.
public
final static assertLessThanOrEqual(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertMatchesRegularExpression()
Asserts that a string matches a given regular expression.
public
final static assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void
Parameters
- $pattern : string
- $string : string
- $message : string = ''
Tags
assertNan()
Asserts that a variable is nan.
public
final static assertNan(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertNotContains()
Asserts that a haystack does not contain a needle.
public
final static assertNotContains(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iterable<string|int, mixed>
- $message : string = ''
Tags
assertNotContainsEquals()
public
final static assertNotContainsEquals(mixed $needle, iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $needle : mixed
- $haystack : iterable<string|int, mixed>
- $message : string = ''
Tags
assertNotContainsOnly()
Asserts that a haystack does not contain only values of a given type.
public
final static assertNotContainsOnly(string $type, iterable<string|int, mixed> $haystack[, bool|null $isNativeType = null ][, string $message = '' ]) : void
Parameters
- $type : string
- $haystack : iterable<string|int, mixed>
- $isNativeType : bool|null = null
- $message : string = ''
Tags
assertNotCount()
Asserts the number of elements of an array, Countable or Traversable.
public
final static assertNotCount(int $expectedCount, Countable|iterable<string|int, mixed> $haystack[, string $message = '' ]) : void
Parameters
- $expectedCount : int
- $haystack : Countable|iterable<string|int, mixed>
- $message : string = ''
Tags
assertNotEmpty()
Asserts that a variable is not empty.
public
final static assertNotEmpty(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertNotEquals()
Asserts that two variables are not equal.
public
final static assertNotEquals(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertNotEqualsCanonicalizing()
Asserts that two variables are not equal (canonicalizing).
public
final static assertNotEqualsCanonicalizing(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertNotEqualsIgnoringCase()
Asserts that two variables are not equal (ignoring case).
public
final static assertNotEqualsIgnoringCase(mixed $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertNotEqualsWithDelta()
Asserts that two variables are not equal (with delta).
public
final static assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta[, string $message = '' ]) : void
Parameters
- $expected : mixed
- $actual : mixed
- $delta : float
- $message : string = ''
Tags
assertNotFalse()
Asserts that a condition is not false.
public
final static assertNotFalse(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
assertNotInstanceOf()
Asserts that a variable is not of a given type.
public
final static assertNotInstanceOf(string $expected, mixed $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : mixed
- $message : string = ''
Tags
assertNotNull()
Asserts that a variable is not null.
public
final static assertNotNull(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertNotSame()
Asserts that two variables do not have the same type and value.
public
final static assertNotSame(mixed $expected, mixed $actual[, string $message = '' ]) : void
Used on objects, it asserts that two variables do not reference the same object.
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertNotSameSize()
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is not the same.
public
final static assertNotSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
- $expected : Countable|iterable<string|int, mixed>
- $actual : Countable|iterable<string|int, mixed>
- $message : string = ''
Tags
assertNotTrue()
Asserts that a condition is not true.
public
final static assertNotTrue(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
assertNull()
Asserts that a variable is null.
public
final static assertNull(mixed $actual[, string $message = '' ]) : void
Parameters
- $actual : mixed
- $message : string = ''
Tags
assertObjectEquals()
public
final static assertObjectEquals(object $expected, object $actual[, string $method = 'equals' ][, string $message = '' ]) : void
Parameters
- $expected : object
- $actual : object
- $method : string = 'equals'
- $message : string = ''
Tags
assertObjectHasProperty()
Asserts that an object has a specified property.
public
final static assertObjectHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
- $propertyName : string
- $object : object
- $message : string = ''
Tags
assertObjectNotHasProperty()
Asserts that an object does not have a specified property.
public
final static assertObjectNotHasProperty(string $propertyName, object $object[, string $message = '' ]) : void
Parameters
- $propertyName : string
- $object : object
- $message : string = ''
Tags
assertSame()
Asserts that two variables have the same type and value.
public
final static assertSame(mixed $expected, mixed $actual[, string $message = '' ]) : void
Used on objects, it asserts that two variables reference the same object.
Parameters
- $expected : mixed
- $actual : mixed
- $message : string = ''
Tags
assertSameSize()
Assert that the size of two arrays (or `Countable` or `Traversable` objects) is the same.
public
final static assertSameSize(Countable|iterable<string|int, mixed> $expected, Countable|iterable<string|int, mixed> $actual[, string $message = '' ]) : void
Parameters
- $expected : Countable|iterable<string|int, mixed>
- $actual : Countable|iterable<string|int, mixed>
- $message : string = ''
Tags
assertStringContainsString()
public
final static assertStringContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
assertStringContainsStringIgnoringCase()
public
final static assertStringContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
assertStringContainsStringIgnoringLineEndings()
public
final static assertStringContainsStringIgnoringLineEndings(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
assertStringEndsNotWith()
Asserts that a string ends not with a given suffix.
public
final static assertStringEndsNotWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
- $suffix : string
- $string : string
- $message : string = ''
Tags
assertStringEndsWith()
Asserts that a string ends with a given suffix.
public
final static assertStringEndsWith(string $suffix, string $string[, string $message = '' ]) : void
Parameters
- $suffix : string
- $string : string
- $message : string = ''
Tags
assertStringEqualsFile()
Asserts that the contents of a string is equal to the contents of a file.
public
final static assertStringEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringEqualsFileCanonicalizing()
Asserts that the contents of a string is equal to the contents of a file (canonicalizing).
public
final static assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringEqualsFileIgnoringCase()
Asserts that the contents of a string is equal to the contents of a file (ignoring case).
public
final static assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringEqualsStringIgnoringLineEndings()
Asserts that two strings are equal except for line endings.
public
final static assertStringEqualsStringIgnoringLineEndings(string $expected, string $actual[, string $message = '' ]) : void
Parameters
- $expected : string
- $actual : string
- $message : string = ''
Tags
assertStringMatchesFormat()
Asserts that a string matches a given format string.
public
final static assertStringMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
- $format : string
- $string : string
- $message : string = ''
Tags
assertStringMatchesFormatFile()
Asserts that a string matches a given format file.
public
final static assertStringMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
- $formatFile : string
- $string : string
- $message : string = ''
Tags
assertStringNotContainsString()
public
final static assertStringNotContainsString(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
assertStringNotContainsStringIgnoringCase()
public
final static assertStringNotContainsStringIgnoringCase(string $needle, string $haystack[, string $message = '' ]) : void
Parameters
- $needle : string
- $haystack : string
- $message : string = ''
Tags
assertStringNotEqualsFile()
Asserts that the contents of a string is not equal to the contents of a file.
public
final static assertStringNotEqualsFile(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringNotEqualsFileCanonicalizing()
Asserts that the contents of a string is not equal to the contents of a file (canonicalizing).
public
final static assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringNotEqualsFileIgnoringCase()
Asserts that the contents of a string is not equal to the contents of a file (ignoring case).
public
final static assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualString : string
- $message : string = ''
Tags
assertStringNotMatchesFormat()
Asserts that a string does not match a given format string.
public
final static assertStringNotMatchesFormat(string $format, string $string[, string $message = '' ]) : void
Parameters
- $format : string
- $string : string
- $message : string = ''
Tags
assertStringNotMatchesFormatFile()
Asserts that a string does not match a given format string.
public
final static assertStringNotMatchesFormatFile(string $formatFile, string $string[, string $message = '' ]) : void
Parameters
- $formatFile : string
- $string : string
- $message : string = ''
Tags
assertStringStartsNotWith()
Asserts that a string starts not with a given prefix.
public
final static assertStringStartsNotWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
- $prefix : string
- $string : string
- $message : string = ''
Tags
assertStringStartsWith()
Asserts that a string starts with a given prefix.
public
final static assertStringStartsWith(string $prefix, string $string[, string $message = '' ]) : void
Parameters
- $prefix : string
- $string : string
- $message : string = ''
Tags
assertThat()
Evaluates a PHPUnit\Framework\Constraint matcher object.
public
final static assertThat(mixed $value, Constraint $constraint[, string $message = '' ]) : void
Parameters
- $value : mixed
- $constraint : Constraint
- $message : string = ''
Tags
assertTrue()
Asserts that a condition is true.
public
final static assertTrue(mixed $condition[, string $message = '' ]) : void
Parameters
- $condition : mixed
- $message : string = ''
Tags
assertXmlFileEqualsXmlFile()
Asserts that two XML files are equal.
public
final static assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
assertXmlFileNotEqualsXmlFile()
Asserts that two XML files are not equal.
public
final static assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualFile : string
- $message : string = ''
Tags
assertXmlStringEqualsXmlFile()
Asserts that two XML documents are equal.
public
final static assertXmlStringEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualXml : string
- $message : string = ''
Tags
assertXmlStringEqualsXmlString()
Asserts that two XML documents are equal.
public
final static assertXmlStringEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedXml : string
- $actualXml : string
- $message : string = ''
Tags
assertXmlStringNotEqualsXmlFile()
Asserts that two XML documents are not equal.
public
final static assertXmlStringNotEqualsXmlFile(string $expectedFile, string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedFile : string
- $actualXml : string
- $message : string = ''
Tags
assertXmlStringNotEqualsXmlString()
Asserts that two XML documents are not equal.
public
final static assertXmlStringNotEqualsXmlString(string $expectedXml, string $actualXml[, string $message = '' ]) : void
Parameters
- $expectedXml : string
- $actualXml : string
- $message : string = ''
Tags
atLeast()
Returns a matcher that matches when the method is executed at least N times.
public
final static atLeast(int $requiredInvocations) : InvokedAtLeastCount
Parameters
- $requiredInvocations : int
Return values
InvokedAtLeastCountatLeastOnce()
Returns a matcher that matches when the method is executed at least once.
public
final static atLeastOnce() : InvokedAtLeastOnce
Return values
InvokedAtLeastOnceatMost()
Returns a matcher that matches when the method is executed at most N times.
public
final static atMost(int $allowedInvocations) : InvokedAtMostCount
Parameters
- $allowedInvocations : int
Return values
InvokedAtMostCountcallback()
public
final static callback(callable $callback) : Callback
Parameters
- $callback : callable
Tags
Return values
CallbackcontainsEqual()
public
final static containsEqual(mixed $value) : TraversableContainsEqual
Parameters
- $value : mixed
Return values
TraversableContainsEqualcontainsIdentical()
public
final static containsIdentical(mixed $value) : TraversableContainsIdentical
Parameters
- $value : mixed
Return values
TraversableContainsIdenticalcontainsOnly()
public
final static containsOnly(string $type) : TraversableContainsOnly
Parameters
- $type : string
Tags
Return values
TraversableContainsOnlycontainsOnlyInstancesOf()
public
final static containsOnlyInstancesOf(string $className) : TraversableContainsOnly
Parameters
- $className : string
Tags
Return values
TraversableContainsOnlycountOf()
public
final static countOf(int $count) : Count
Parameters
- $count : int
Return values
CountdirectoryExists()
public
final static directoryExists() : DirectoryExists
Return values
DirectoryExistsequalTo()
public
final static equalTo(mixed $value) : IsEqual
Parameters
- $value : mixed
Return values
IsEqualequalToCanonicalizing()
public
final static equalToCanonicalizing(mixed $value) : IsEqualCanonicalizing
Parameters
- $value : mixed
Return values
IsEqualCanonicalizingequalToIgnoringCase()
public
final static equalToIgnoringCase(mixed $value) : IsEqualIgnoringCase
Parameters
- $value : mixed
Return values
IsEqualIgnoringCaseequalToWithDelta()
public
final static equalToWithDelta(mixed $value, float $delta) : IsEqualWithDelta
Parameters
- $value : mixed
- $delta : float
Return values
IsEqualWithDeltaexactly()
Returns a matcher that matches when the method is executed exactly $count times.
public
final static exactly(int $count) : InvokedCount
Parameters
- $count : int
Return values
InvokedCountexpectException()
public
final expectException(string $exception) : void
Parameters
- $exception : string
Tags
expectExceptionCode()
public
final expectExceptionCode(int|string $code) : void
Parameters
- $code : int|string
expectExceptionMessage()
public
final expectExceptionMessage(string $message) : void
Parameters
- $message : string
expectExceptionMessageMatches()
public
final expectExceptionMessageMatches(string $regularExpression) : void
Parameters
- $regularExpression : string
expectExceptionObject()
Sets up an expectation for an exception to be raised by the code under test.
public
final expectExceptionObject(Exception $exception) : void
Information for expected exception class, expected exception message, and expected exception code are retrieved from a given Exception object.
Parameters
- $exception : Exception
expectNotToPerformAssertions()
public
final expectNotToPerformAssertions() : void
expectOutputRegex()
public
final expectOutputRegex(string $expectedRegex) : void
Parameters
- $expectedRegex : string
expectOutputString()
public
final expectOutputString(string $expectedString) : void
Parameters
- $expectedString : string
fail()
Fails a test with the given message.
public
final static fail([string $message = '' ]) : never
Parameters
- $message : string = ''
Tags
Return values
neverfileExists()
public
final static fileExists() : FileExists
Return values
FileExistsgetActualOutputForAssertion()
public
final getActualOutputForAssertion() : string
Return values
stringgetCount()
Return the current assertion count.
public
final static getCount() : int
Return values
intgetMockBuilder()
Returns a builder object to create mock objects using a fluent interface.
public
final getMockBuilder(string $className) : MockBuilder
Parameters
- $className : string
Tags
Return values
MockBuildergreaterThan()
public
final static greaterThan(mixed $value) : GreaterThan
Parameters
- $value : mixed
Return values
GreaterThangreaterThanOrEqual()
public
final static greaterThanOrEqual(mixed $value) : LogicalOr
Parameters
- $value : mixed
Return values
LogicalOridenticalTo()
public
final static identicalTo(mixed $value) : IsIdentical
Parameters
- $value : mixed
Return values
IsIdenticalisEmpty()
public
final static isEmpty() : IsEmpty
Return values
IsEmptyisFalse()
public
final static isFalse() : IsFalse
Return values
IsFalseisFinite()
public
final static isFinite() : IsFinite
Return values
IsFiniteisInfinite()
public
final static isInfinite() : IsInfinite
Return values
IsInfiniteisInstanceOf()
public
final static isInstanceOf(string $className) : IsInstanceOf
Parameters
- $className : string
Tags
Return values
IsInstanceOfisJson()
public
final static isJson() : IsJson
Return values
IsJsonisList()
public
final static isList() : IsList
Return values
IsListisNan()
public
final static isNan() : IsNan
Return values
IsNanisNull()
public
final static isNull() : IsNull
Return values
IsNullisReadable()
public
final static isReadable() : IsReadable
Return values
IsReadableisTrue()
public
final static isTrue() : IsTrue
Return values
IsTrueisType()
public
final static isType(string $type) : IsType
Parameters
- $type : string
Tags
Return values
IsTypeisWritable()
public
final static isWritable() : IsWritable
Return values
IsWritablelessThan()
public
final static lessThan(mixed $value) : LessThan
Parameters
- $value : mixed
Return values
LessThanlessThanOrEqual()
public
final static lessThanOrEqual(mixed $value) : LogicalOr
Parameters
- $value : mixed
Return values
LogicalOrlogicalAnd()
public
final static logicalAnd(mixed ...$constraints) : LogicalAnd
Parameters
- $constraints : mixed
Tags
Return values
LogicalAndlogicalNot()
public
final static logicalNot(Constraint $constraint) : LogicalNot
Parameters
- $constraint : Constraint
Return values
LogicalNotlogicalOr()
public
final static logicalOr(mixed ...$constraints) : LogicalOr
Parameters
- $constraints : mixed
Return values
LogicalOrlogicalXor()
public
final static logicalXor(mixed ...$constraints) : LogicalXor
Parameters
- $constraints : mixed
Return values
LogicalXormarkTestIncomplete()
Mark the test as incomplete.
public
final static markTestIncomplete([string $message = '' ]) : never
Parameters
- $message : string = ''
Tags
Return values
nevermarkTestSkipped()
Mark the test as skipped.
public
final static markTestSkipped([string $message = '' ]) : never
Parameters
- $message : string = ''
Tags
Return values
nevermatches()
public
final static matches(string $string) : StringMatchesFormatDescription
Parameters
- $string : string
Return values
StringMatchesFormatDescriptionmatchesRegularExpression()
public
final static matchesRegularExpression(string $pattern) : RegularExpression
Parameters
- $pattern : string
Return values
RegularExpressionnever()
Returns a matcher that matches when the method is never executed.
public
final static never() : InvokedCount
Return values
InvokedCountobjectEquals()
public
final static objectEquals(object $object[, string $method = 'equals' ]) : ObjectEquals
Parameters
- $object : object
- $method : string = 'equals'
Return values
ObjectEqualsonce()
Returns a matcher that matches when the method is executed exactly once.
public
final static once() : InvokedCount
Return values
InvokedCountonConsecutiveCalls()
public
final static onConsecutiveCalls(mixed ...$arguments) : ConsecutiveCalls
Parameters
- $arguments : mixed
Tags
Return values
ConsecutiveCallsresetCount()
Reset the assertion counter.
public
final static resetCount() : void
returnArgument()
public
final static returnArgument(int $argumentIndex) : ReturnArgument
Parameters
- $argumentIndex : int
Tags
Return values
ReturnArgumentreturnCallback()
public
final static returnCallback(callable $callback) : ReturnCallback
Parameters
- $callback : callable
Tags
Return values
ReturnCallbackreturnSelf()
public
final static returnSelf() : ReturnSelf
Tags
Return values
ReturnSelfreturnValue()
public
final static returnValue(mixed $value) : ReturnStub
Parameters
- $value : mixed
Tags
Return values
ReturnStubreturnValueMap()
public
final static returnValueMap(array<string|int, mixed> $valueMap) : ReturnValueMap
Parameters
- $valueMap : array<string|int, mixed>
Tags
Return values
ReturnValueMapsetUpBeforeClass()
This method is called before the first test of this test class is run.
public
static setUpBeforeClass() : void
Tags
stringContains()
public
final static stringContains(string $string[, bool $case = true ]) : StringContains
Parameters
- $string : string
- $case : bool = true
Return values
StringContainsstringEndsWith()
public
final static stringEndsWith(string $suffix) : StringEndsWith
Parameters
- $suffix : string
Tags
Return values
StringEndsWithstringEqualsStringIgnoringLineEndings()
public
final static stringEqualsStringIgnoringLineEndings(string $string) : StringEqualsStringIgnoringLineEndings
Parameters
- $string : string
Return values
StringEqualsStringIgnoringLineEndingsstringStartsWith()
public
final static stringStartsWith(string $prefix) : StringStartsWith
Parameters
- $prefix : string
Tags
Return values
StringStartsWithtearDownAfterClass()
This method is called after the last test of this test class is run.
public
static tearDownAfterClass() : void
Tags
throwException()
public
final static throwException(Throwable $exception) : Exception
Parameters
- $exception : Throwable
Return values
ExceptionassertPostConditions()
Performs assertions shared by all tests of a test case.
protected
assertPostConditions() : void
This method is called between test and tearDown().
Tags
assertPreConditions()
Performs assertions shared by all tests of a test case.
protected
assertPreConditions() : void
This method is called between setUp() and test.
Tags
createConfiguredMock()
Creates (and configures) a mock object for the specified interface or class.
protected
createConfiguredMock(string $originalClassName, array<string|int, mixed> $configuration) : MockObject
Parameters
- $originalClassName : string
- $configuration : array<string|int, mixed>
Tags
Return values
MockObjectcreateConfiguredStub()
Creates (and configures) a test stub for the specified interface or class.
protected
final static createConfiguredStub(string $originalClassName, array<string|int, mixed> $configuration) : Stub
Parameters
- $originalClassName : string
- $configuration : array<string|int, mixed>
Tags
Return values
StubcreateMock()
Creates a mock object for the specified interface or class.
protected
createMock(string $originalClassName) : MockObject
Parameters
- $originalClassName : string
Tags
Return values
MockObjectcreateMockForIntersectionOfInterfaces()
protected
createMockForIntersectionOfInterfaces(array<string|int, mixed> $interfaces) : MockObject
Parameters
- $interfaces : array<string|int, mixed>
Tags
Return values
MockObjectcreatePartialMock()
Creates a partial mock object for the specified interface or class.
protected
createPartialMock(string $originalClassName, array<string|int, mixed> $methods) : MockObject
Parameters
- $originalClassName : string
- $methods : array<string|int, mixed>
Tags
Return values
MockObjectcreateStub()
Creates a test stub for the specified interface or class.
protected
static createStub(string $originalClassName) : Stub
Parameters
- $originalClassName : string
Tags
Return values
StubcreateStubForIntersectionOfInterfaces()
protected
static createStubForIntersectionOfInterfaces(array<string|int, mixed> $interfaces) : Stub
Parameters
- $interfaces : array<string|int, mixed>
Tags
Return values
StubcreateTestProxy()
Creates a test proxy for the specified class.
protected
createTestProxy(string $originalClassName[, array<string|int, mixed> $constructorArguments = [] ]) : MockObject
Parameters
- $originalClassName : string
- $constructorArguments : array<string|int, mixed> = []
Tags
Return values
MockObjectgetMockForAbstractClass()
Creates a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.
protected
getMockForAbstractClass(string $originalClassName[, array<string|int, mixed> $arguments = [] ][, string $mockClassName = '' ][, bool $callOriginalConstructor = true ][, bool $callOriginalClone = true ][, bool $callAutoload = true ][, array<string|int, mixed> $mockedMethods = [] ][, bool $cloneArguments = false ]) : MockObject
To mock concrete methods, use the 7th parameter ($mockedMethods).
Parameters
- $originalClassName : string