Class TestCase

Cake TestCase class

Abstract
Namespace: Cake\TestSuite

Property Summary

$_configure protected

array

Configure values to restore at end of test.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Table locator instance
$appPluginsToLoad protected

array

Plugins to be loaded after app instance is created ContainerStubTrait::creatApp()
$defaultTable protected

string|null

This object's default table alias.
$fixtureStrategy protected

Cake\TestSuite\Fixture\FixtureStrategyInterface|null
$fixtures protected

array<string>

Fixtures used by this test case.

Method Summary

__construct() public
_assertAttributes() protected

Check the attributes as part of an assertTags() check.
_getTableClassName() protected

Gets the class name for the table.
_normalizePath() protected

Normalize a path for comparison.
addFixture() protected

Adds a fixture to this test case.
addToAssertionCount() public
any() protected

Returns a matcher that matches when the method is executed zero or more times.
anything() public static
arrayHasKey() public static
assertArrayHasKey() public static

Asserts that an array has a specified key.
assertArrayIsEqualToArrayIgnoringListOfKeys() public static

Asserts that two arrays are equal while ignoring a list of keys.
assertArrayIsEqualToArrayOnlyConsideringListOfKeys() public static

Asserts that two arrays are equal while only considering a list of keys.
assertArrayIsIdenticalToArrayIgnoringListOfKeys() public static

Asserts that two arrays are equal while ignoring a list of keys.
assertArrayIsIdenticalToArrayOnlyConsideringListOfKeys() public static

Asserts that two arrays are identical while only considering a list of keys.
assertArrayNotHasKey() public static

Asserts that an array does not have a specified key.
assertContains() public static

Asserts that a haystack contains a needle.
assertContainsEquals() public static
assertContainsNotOnlyArray() public static

Asserts that a haystack does not contain only values of type array.
assertContainsNotOnlyBool() public static

Asserts that a haystack does not contain only values of type bool.
assertContainsNotOnlyCallable() public static

Asserts that a haystack does not contain only values of type callable.
assertContainsNotOnlyClosedResource() public static

Asserts that a haystack does not contain only values of type closed resource.
assertContainsNotOnlyFloat() public static

Asserts that a haystack does not contain only values of type float.
assertContainsNotOnlyInstancesOf() public static

Asserts that a haystack does not contain only instances of a specified interface or class name.
assertContainsNotOnlyInt() public static

Asserts that a haystack does not contain only values of type int.
assertContainsNotOnlyIterable() public static

Asserts that a haystack does not contain only values of type iterable.
assertContainsNotOnlyNull() public static

Asserts that a haystack does not contain only values of type null.
assertContainsNotOnlyNumeric() public static

Asserts that a haystack does not contain only values of type numeric.
assertContainsNotOnlyObject() public static

Asserts that a haystack does not contain only values of type object.
assertContainsNotOnlyResource() public static

Asserts that a haystack does not contain only values of type resource.
assertContainsNotOnlyScalar() public static

Asserts that a haystack does not contain only values of type scalar.
assertContainsNotOnlyString() public static

Asserts that a haystack does not contain only values of type string.
assertContainsOnly() public static deprecated

Asserts that a haystack contains only values of a given type.
assertContainsOnlyArray() public static

Asserts that a haystack contains only values of type array.
assertContainsOnlyBool() public static

Asserts that a haystack contains only values of type bool.
assertContainsOnlyCallable() public static

Asserts that a haystack contains only values of type callable.
assertContainsOnlyClosedResource() public static

Asserts that a haystack contains only values of type closed resource.
assertContainsOnlyFloat() public static

Asserts that a haystack contains only values of type float.
assertContainsOnlyInstancesOf() public static

Asserts that a haystack contains only instances of a specified interface or class name.
assertContainsOnlyInt() public static

Asserts that a haystack contains only values of type int.
assertContainsOnlyIterable() public static

Asserts that a haystack contains only values of type iterable.
assertContainsOnlyNull() public static

Asserts that a haystack contains only values of type null.
assertContainsOnlyNumeric() public static

Asserts that a haystack contains only values of type numeric.
assertContainsOnlyObject() public static

Asserts that a haystack contains only values of type object.
assertContainsOnlyResource() public static

Asserts that a haystack contains only values of type resource.
assertContainsOnlyScalar() public static

Asserts that a haystack contains only values of type scalar.
assertContainsOnlyString() public static

Asserts that a haystack contains only values of type string.
assertCount() public static

Asserts the number of elements of an array, Countable or Traversable.
assertDirectoryDoesNotExist() public static

Asserts that a directory does not exist.
assertDirectoryExists() public static

Asserts that a directory exists.
assertDirectoryIsNotReadable() public static

Asserts that a directory exists and is not readable.
assertDirectoryIsNotWritable() public static

Asserts that a directory exists and is not writable.
assertDirectoryIsReadable() public static

Asserts that a directory exists and is readable.
assertDirectoryIsWritable() public static

Asserts that a directory exists and is writable.
assertDoesNotMatchRegularExpression() public static

Asserts that a string does not match a given regular expression.
assertEmpty() public static

Asserts that a variable is empty.
assertEquals() public static

Asserts that two variables are equal.
assertEqualsCanonicalizing() public static

Asserts that two variables are equal (canonicalizing).
assertEqualsIgnoringCase() public static

Asserts that two variables are equal (ignoring case).
assertEqualsSql() public

Assert that a string matches SQL with db-specific characters like quotes removed.
assertEqualsWithDelta() public static

Asserts that two variables are equal (with delta).
assertEventFired() public

Asserts that a global event was fired. You must track events in your event manager for this assertion to work
assertEventFiredWith() public

Asserts an event was fired with data
assertFalse() public static

Asserts that a condition is false.
assertFileDoesNotExist() public static

Asserts that a file does not exist.
assertFileEquals() public static

Asserts that the contents of one file is equal to the contents of another file.
assertFileEqualsCanonicalizing() public static

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

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

Asserts that a file exists.
assertFileIsNotReadable() public static

Asserts that a file exists and is not readable.
assertFileIsNotWritable() public static

Asserts that a file exists and is not writable.
assertFileIsReadable() public static

Asserts that a file exists and is readable.
assertFileIsWritable() public static

Asserts that a file exists and is writable.
assertFileMatchesFormat() public static

Asserts that a string matches a given format string.
assertFileMatchesFormatFile() public static

Asserts that a string matches a given format string.
assertFileNotEquals() public static

Asserts that the contents of one file is not equal to the contents of another file.
assertFileNotEqualsCanonicalizing() public static

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

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

Asserts that a variable is finite.
assertGreaterThan() public static

Asserts that a value is greater than another value.
assertGreaterThanOrEqual() public static

Asserts that a value is greater than or equal to another value.
assertHtml() public

Asserts HTML tags.
assertInfinite() public static

Asserts that a variable is infinite.
assertInstanceOf() public static

Asserts that a variable is of a given type.
assertIsArray() public static

Asserts that a variable is of type array.
assertIsBool() public static

Asserts that a variable is of type bool.
assertIsCallable() public static

Asserts that a variable is of type callable.
assertIsClosedResource() public static

Asserts that a variable is of type resource and is closed.
assertIsFloat() public static

Asserts that a variable is of type float.
assertIsInt() public static

Asserts that a variable is of type int.
assertIsIterable() public static

Asserts that a variable is of type iterable.
assertIsList() public static
assertIsNotArray() public static

Asserts that a variable is not of type array.
assertIsNotBool() public static

Asserts that a variable is not of type bool.
assertIsNotCallable() public static

Asserts that a variable is not of type callable.
assertIsNotClosedResource() public static

Asserts that a variable is not of type resource.
assertIsNotFloat() public static

Asserts that a variable is not of type float.
assertIsNotInt() public static

Asserts that a variable is not of type int.
assertIsNotIterable() public static

Asserts that a variable is not of type iterable.
assertIsNotNumeric() public static

Asserts that a variable is not of type numeric.
assertIsNotObject() public static

Asserts that a variable is not of type object.
assertIsNotReadable() public static

Asserts that a file/dir exists and is not readable.
assertIsNotResource() public static

Asserts that a variable is not of type resource.
assertIsNotScalar() public static

Asserts that a variable is not of type scalar.
assertIsNotString() public static

Asserts that a variable is not of type string.
assertIsNotWritable() public static

Asserts that a file/dir exists and is not writable.
assertIsNumeric() public static

Asserts that a variable is of type numeric.
assertIsObject() public static

Asserts that a variable is of type object.
assertIsReadable() public static

Asserts that a file/dir is readable.
assertIsResource() public static

Asserts that a variable is of type resource.
assertIsScalar() public static

Asserts that a variable is of type scalar.
assertIsString() public static

Asserts that a variable is of type string.
assertIsWritable() public static

Asserts that a file/dir exists and is writable.
assertJson() public static

Asserts that a string is a valid JSON string.
assertJsonFileEqualsJsonFile() public static

Asserts that two JSON files are equal.
assertJsonFileNotEqualsJsonFile() public static

Asserts that two JSON files are not equal.
assertJsonStringEqualsJsonFile() public static

Asserts that the generated JSON encoded object and the content of the given file are equal.
assertJsonStringEqualsJsonString() public static

Asserts that two given JSON encoded objects or arrays are equal.
assertJsonStringNotEqualsJsonFile() public static

Asserts that the generated JSON encoded object and the content of the given file are not equal.
assertJsonStringNotEqualsJsonString() public static

Asserts that two given JSON encoded objects or arrays are not equal.
assertLessThan() public static

Asserts that a value is smaller than another value.
assertLessThanOrEqual() public static

Asserts that a value is smaller than or equal to another value.
assertMatchesRegularExpression() public static

Asserts that a string matches a given regular expression.
assertNan() public static

Asserts that a variable is nan.
assertNotContains() public static

Asserts that a haystack does not contain a needle.
assertNotContainsEquals() public static
assertNotContainsOnly() public static deprecated

Asserts that a haystack does not contain only values of a given type.
assertNotCount() public static

Asserts the number of elements of an array, Countable or Traversable.
assertNotEmpty() public static

Asserts that a variable is not empty.
assertNotEquals() public static

Asserts that two variables are not equal.
assertNotEqualsCanonicalizing() public static

Asserts that two variables are not equal (canonicalizing).
assertNotEqualsIgnoringCase() public static

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

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

Asserts that a condition is not false.
assertNotInstanceOf() public static

Asserts that a variable is not of a given type.
assertNotNull() public static

Asserts that a variable is not null.
assertNotSame() public 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.
assertNotSameSize() public static

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

Asserts that a condition is not true.
assertNotWithinRange() protected static

Compatibility function to test if a value is not between an acceptable range.
assertNull() public static

Asserts that a variable is null.
assertObjectEquals() public static
assertObjectHasProperty() public static

Asserts that an object has a specified property.
assertObjectNotEquals() public static
assertObjectNotHasProperty() public static

Asserts that an object does not have a specified property.
assertPathEquals() protected static

Compatibility function to test paths.
assertPostConditions() protected

This method is called between test and tearDown().
assertPreConditions() protected

Performs assertions shared by all tests of a test case.
assertRegExpSql() public

Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters < and >. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries
assertSame() public static

Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference the same object.
assertSameSize() public static

Assert that the size of two arrays (or Countable or Traversable objects) is the same.
assertStringContainsString() public static
assertStringContainsStringIgnoringCase() public static
assertStringContainsStringIgnoringLineEndings() public static
assertStringEndsNotWith() public static

Asserts that a string ends not with a given suffix.
assertStringEndsWith() public static

Asserts that a string ends with a given suffix.
assertStringEqualsFile() public static

Asserts that the contents of a string is equal to the contents of a file.
assertStringEqualsFileCanonicalizing() public static

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

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

Asserts that two strings are equal except for line endings.
assertStringMatchesFormat() public static

Asserts that a string matches a given format string.
assertStringMatchesFormatFile() public static

Asserts that a string matches a given format file.
assertStringNotContainsString() public static
assertStringNotContainsStringIgnoringCase() public static
assertStringNotEqualsFile() public static

Asserts that the contents of a string is not equal to the contents of a file.
assertStringNotEqualsFileCanonicalizing() public static

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

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

Asserts that a string starts not with a given prefix.
assertStringStartsWith() public static

Asserts that a string starts with a given prefix.
assertTextContains() public

Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextEndsNotWith() public

Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextEndsWith() public

Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextEquals() public

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextNotContains() public

Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextNotEquals() public

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextStartsNotWith() public

Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertTextStartsWith() public

Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.
assertThat() public static

Evaluates a PHPUnit\Framework\Constraint matcher object.
assertTrue() public static

Asserts that a condition is true.
assertWithinRange() protected static

Compatibility function to test if a value is between an acceptable range.
assertXmlFileEqualsXmlFile() public static

Asserts that two XML files are equal.
assertXmlFileNotEqualsXmlFile() public static

Asserts that two XML files are not equal.
assertXmlStringEqualsXmlFile() public static

Asserts that two XML documents are equal.
assertXmlStringEqualsXmlString() public static

Asserts that two XML documents are equal.
assertXmlStringNotEqualsXmlFile() public static

Asserts that two XML documents are not equal.
assertXmlStringNotEqualsXmlString() public static

Asserts that two XML documents are not equal.
atLeast() protected

Returns a matcher that matches when the method is executed at least N times.
atLeastOnce() protected

Returns a matcher that matches when the method is executed at least once.
atMost() protected

Returns a matcher that matches when the method is executed at most N times.
callback() public static
captureError() public

Capture errors from $callable so that you can do assertions on the error.
clearPlugins() public

Clear all plugins from the global plugin collection.
containsEqual() public static
containsIdentical() public static
containsOnly() public static deprecated
containsOnlyArray() public static
containsOnlyBool() public static
containsOnlyCallable() public static
containsOnlyClosedResource() public static
containsOnlyFloat() public static
containsOnlyInstancesOf() public static
containsOnlyInt() public static
containsOnlyIterable() public static
containsOnlyNull() public static
containsOnlyNumeric() public static
containsOnlyObject() public static
containsOnlyResource() public static
containsOnlyScalar() public static
containsOnlyString() public static
count() public
countOf() public static
createConfiguredMock() protected

Creates (and configures) a mock object for the specified interface or class.
createConfiguredStub() protected static

Creates (and configures) a test stub for the specified interface or class.
createMock() protected

Creates a mock object for the specified interface or class.
createMockForIntersectionOfInterfaces() protected
createPartialMock() protected

Creates a partial mock object for the specified interface or class.
createStub() protected static

Creates a test stub for the specified interface or class.
createStubForIntersectionOfInterfaces() protected static
dataName() public
dataSetAsString() public
dataSetAsStringWithData() public
dependencyInput() public
deprecated() public

Helper method for check deprecation methods
directoryExists() public static
doesNotPerformAssertions() public
equalTo() public static
equalToCanonicalizing() public static
equalToIgnoringCase() public static
equalToWithDelta() public static
exactly() protected

Returns a matcher that matches when the method is executed exactly $count times.
expectDeprecationMessageMatches() public
expectErrorHandlerMessageMatches() protected
expectErrorLog() protected
expectErrorMessageMatches() public
expectException() protected
expectExceptionCode() protected
expectExceptionMessage() protected
expectExceptionMessageMatches() protected
expectExceptionObject() protected

Sets up an expectation for an exception to be raised by the code under test. Information for expected exception class, expected exception message, and expected exception code are retrieved from a given Exception object.
expectNotToPerformAssertions() protected
expectNoticeMessageMatches() public
expectOutputRegex() protected
expectOutputString() protected
expectUserDeprecationMessage() protected
expectUserDeprecationMessageMatches() protected
expectWarningMessageMatches() public
expectsOutput() public
fail() public static

Fails a test with the given message.
fetchTable() public

Convenience method to get a table instance.
fileExists() public static
getActualOutputForAssertion() protected
getCount() public static

Return the current assertion count.
getFixtureStrategy() protected

Returns fixture strategy used by these tests.
getFixtures() public

Get the fixtures this test should use.
getMockBuilder() protected

Returns a builder object to create mock objects using a fluent interface.
getMockForModel() public

Mock a model, maintain fixtures and table association
getTableLocator() public

Gets the table locator.
greaterThan() public static
greaterThanOrEqual() public static
groups() public
hasDependencyInput() public
hasUnexpectedOutput() public
identicalTo() public static
isArray() public static
isBool() public static
isCallable() public static
isClosedResource() public static
isEmpty() public static
isFalse() public static
isFinite() public static
isFloat() public static
isInfinite() public static
isInstanceOf() public static
isInt() public static
isIterable() public static
isJson() public static
isList() public static
isNan() public static
isNull() public static
isNumeric() public static
isObject() public static
isReadable() public static
isResource() public static
isScalar() public static
isString() public static
isTrue() public static
isType() public static deprecated
isWritable() public static
lessThan() public static
lessThanOrEqual() public static
loadPlugins() public

Load plugins into a simulated application.
loadRoutes() public

Load routes for the application.
logicalAnd() public static
logicalNot() public static
logicalOr() public static
logicalXor() public static
markTestIncomplete() public static

Mark the test as incomplete.
markTestSkipped() public static

Mark the test as skipped.
matches() public static
matchesRegularExpression() public static
name() public
nameWithDataSet() public
never() protected

Returns a matcher that matches when the method is never executed.
numberOfAssertionsPerformed() public
objectEquals() public static
onNotSuccessfulTest() protected

This method is called when a test method did not execute successfully.
once() protected

Returns a matcher that matches when the method is executed exactly once.
output() public
provideAdditionalInformation() protected
providedData() public
provides() public
registerComparator() protected
registerFailureType() protected
registerMockObject() public
removePlugins() public

Remove plugins from the global plugin collection.
requires() public
resetCount() public static

Reset the assertion counter.
result() public
run() public
runBare() public
setAppNamespace() public static

Set the app namespace
setBackupGlobals() public
setBackupGlobalsExcludeList() public
setBackupStaticProperties() public
setBackupStaticPropertiesExcludeList() public
setData() public
setDependencies() public
setDependencyInput() public
setGroups() public
setInIsolation() public
setPreserveGlobalState() public
setResult() public
setRunClassInSeparateProcess() public
setRunTestInSeparateProcess() public
setTableLocator() public

Sets the table locator.
setUp() protected

Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.
setUpBeforeClass() public static

This method is called before the first test of this test class is run.
setupFixtures() protected

Initialized and loads any use fixtures.
size() public
skipIf() public

Overrides SimpleTestCase::skipIf to provide a boolean return value
skipUnless() protected

Compatibility function for skipping.
sortId() public
status() public
stringContains() public static
stringEndsWith() public static
stringEqualsStringIgnoringLineEndings() public static
stringStartsWith() public static
tearDown() protected

teardown any static object changes and restore them.
tearDownAfterClass() public static

This method is called after the last test of this test class is run.
teardownFixtures() protected

Unloads any use fixtures.
throwException() protected
toString() public

Returns a string representation of the test case.
transformException() protected
usesDataProvider() public
valueObjectForEvents() public
wasPrepared() public
withConsecutive() public static
withErrorReporting() public

Helper method for tests that needs to use error_reporting()

Method Detail

__construct() ¶ public

__construct(non-empty-string $name)

Parameters

non-empty-string $name

_assertAttributes() ¶ protected

_assertAttributes(array<string, mixed> $assertions, string $string, bool $fullDebug = false, array|string $regex = ''): string|false

Check the attributes as part of an assertTags() check.

Parameters

array<string, mixed> $assertions: Assertions to run.
string $string: The HTML string to check.
bool $fullDebug optional: Whether more verbose output should be used.
array|string $regex optional: Full regexp from assertHtml

Returns

string|false

_getTableClassName() ¶ protected

_getTableClassName(string $alias, array<string, mixed> $options): class-string<Cake\ORM\Table>

Gets the class name for the table.

Parameters

string $alias: The model to get a mock for.
array<string, mixed> $options: The config data for the mock's constructor.

Returns

class-string<Cake\ORM\Table>

Throws

Cake\ORM\Exception\MissingTableClassException

_normalizePath() ¶ protected

_normalizePath(string $path): string

Normalize a path for comparison.

Parameters

string $path: Path separated by "/" slash.

Returns

string

Normalized path separated by DIRECTORY_SEPARATOR.

addFixture() ¶ protected

addFixture(string $fixture): $this

Adds a fixture to this test case.

Examples:

core.Tags
app.MyRecords
plugin.MyPluginName.MyModelName

Use this method inside your test cases' {@link getFixtures()} method to build up the fixture list.

Parameters

string $fixture: Fixture

Returns

$this

addToAssertionCount() ¶ public

addToAssertionCount(int $count): void

Parameters

int $count

Returns

void

any() ¶ protected

any(): AnyInvokedCountMatcher

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

Returns

AnyInvokedCountMatcher

anything() ¶ public static

anything(): IsAnything

Returns

IsAnything

arrayHasKey() ¶ public static

arrayHasKey(mixed $key): ArrayHasKey

Parameters

mixed $key

Returns

ArrayHasKey

assertArrayHasKey() ¶ public static

assertArrayHasKey(mixed $key, array<mixed>|ArrayAccess<array-key, mixed> $array, string $message = ''): void

Asserts that an array has a specified key.

Parameters

mixed $key
array<mixed>|ArrayAccess<array-key, mixed> $array
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertArrayIsEqualToArrayIgnoringListOfKeys() ¶ public static

assertArrayIsEqualToArrayIgnoringListOfKeys(array<mixed> $expected, array<mixed> $actual, non-empty-list<array-key> $keysToBeIgnored, string $message = ''): void

Asserts that two arrays are equal while ignoring a list of keys.

Parameters

array<mixed> $expected
array<mixed> $actual
non-empty-list<array-key> $keysToBeIgnored
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertArrayIsEqualToArrayOnlyConsideringListOfKeys() ¶ public static

assertArrayIsEqualToArrayOnlyConsideringListOfKeys(array<mixed> $expected, array<mixed> $actual, non-empty-list<array-key> $keysToBeConsidered, string $message = ''): void

Asserts that two arrays are equal while only considering a list of keys.

Parameters

array<mixed> $expected
array<mixed> $actual
non-empty-list<array-key> $keysToBeConsidered
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertArrayIsIdenticalToArrayIgnoringListOfKeys() ¶ public static

assertArrayIsIdenticalToArrayIgnoringListOfKeys(array<mixed> $expected, array<mixed> $actual, non-empty-list<array-key> $keysToBeIgnored, string $message = ''): void

Asserts that two arrays are equal while ignoring a list of keys.

Parameters

array<mixed> $expected
array<mixed> $actual
non-empty-list<array-key> $keysToBeIgnored
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertArrayIsIdenticalToArrayOnlyConsideringListOfKeys() ¶ public static

assertArrayIsIdenticalToArrayOnlyConsideringListOfKeys(array<mixed> $expected, array<mixed> $actual, non-empty-list<array-key> $keysToBeConsidered, string $message = ''): void

Asserts that two arrays are identical while only considering a list of keys.

Parameters

array<mixed> $expected
array<mixed> $actual
non-empty-list<array-key> $keysToBeConsidered
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertArrayNotHasKey() ¶ public static

assertArrayNotHasKey(mixed $key, array<mixed>|ArrayAccess<array-key, mixed> $array, string $message = ''): void

Asserts that an array does not have a specified key.

Parameters

mixed $key
array<mixed>|ArrayAccess<array-key, mixed> $array
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertContains() ¶ public static

assertContains(mixed $needle, iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains a needle.

Parameters

mixed $needle
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertContainsEquals() ¶ public static

assertContainsEquals(mixed $needle, iterable<mixed> $haystack, string $message = ''): void

Parameters

mixed $needle
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyArray() ¶ public static

assertContainsNotOnlyArray(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyBool() ¶ public static

assertContainsNotOnlyBool(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyCallable() ¶ public static

assertContainsNotOnlyCallable(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyClosedResource() ¶ public static

assertContainsNotOnlyClosedResource(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyFloat() ¶ public static

assertContainsNotOnlyFloat(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyInstancesOf() ¶ public static

assertContainsNotOnlyInstancesOf(class-string $className, iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack does not contain only instances of a specified interface or class name.

Parameters

class-string $className
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertContainsNotOnlyInt() ¶ public static

assertContainsNotOnlyInt(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyIterable() ¶ public static

assertContainsNotOnlyIterable(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyNull() ¶ public static

assertContainsNotOnlyNull(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyNumeric() ¶ public static

assertContainsNotOnlyNumeric(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyObject() ¶ public static

assertContainsNotOnlyObject(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyResource() ¶ public static

assertContainsNotOnlyResource(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyScalar() ¶ public static

assertContainsNotOnlyScalar(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsNotOnlyString() ¶ public static

assertContainsNotOnlyString(iterable<mixed> $haystack, string $message = ''): void

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

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnly() ¶ public static

assertContainsOnly(array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type, iterable<mixed> $haystack, ?bool $isNativeType = null, string $message = ''): void

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

Parameters

array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type
iterable<mixed> $haystack
?bool $isNativeType optional
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertContainsOnlyArray() ¶ public static

assertContainsOnlyArray(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type array.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyBool() ¶ public static

assertContainsOnlyBool(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type bool.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyCallable() ¶ public static

assertContainsOnlyCallable(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type callable.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyClosedResource() ¶ public static

assertContainsOnlyClosedResource(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type closed resource.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyFloat() ¶ public static

assertContainsOnlyFloat(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type float.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyInstancesOf() ¶ public static

assertContainsOnlyInstancesOf(class-string<T> $className, iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only instances of a specified interface or class name.

Templates

Parameters

class-string<T> $className
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertContainsOnlyInt() ¶ public static

assertContainsOnlyInt(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type int.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyIterable() ¶ public static

assertContainsOnlyIterable(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type iterable.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyNull() ¶ public static

assertContainsOnlyNull(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type null.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyNumeric() ¶ public static

assertContainsOnlyNumeric(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type numeric.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyObject() ¶ public static

assertContainsOnlyObject(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type object.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyResource() ¶ public static

assertContainsOnlyResource(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type resource.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyScalar() ¶ public static

assertContainsOnlyScalar(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type scalar.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertContainsOnlyString() ¶ public static

assertContainsOnlyString(iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack contains only values of type string.

Parameters

iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertCount() ¶ public static

assertCount(int $expectedCount, Countable|iterable<mixed> $haystack, string $message = ''): void

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

Parameters

int $expectedCount
Countable|iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

GeneratorNotSupportedException

assertDirectoryDoesNotExist() ¶ public static

assertDirectoryDoesNotExist(string $directory, string $message = ''): void

Asserts that a directory does not exist.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDirectoryExists() ¶ public static

assertDirectoryExists(string $directory, string $message = ''): void

Asserts that a directory exists.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDirectoryIsNotReadable() ¶ public static

assertDirectoryIsNotReadable(string $directory, string $message = ''): void

Asserts that a directory exists and is not readable.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDirectoryIsNotWritable() ¶ public static

assertDirectoryIsNotWritable(string $directory, string $message = ''): void

Asserts that a directory exists and is not writable.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDirectoryIsReadable() ¶ public static

assertDirectoryIsReadable(string $directory, string $message = ''): void

Asserts that a directory exists and is readable.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDirectoryIsWritable() ¶ public static

assertDirectoryIsWritable(string $directory, string $message = ''): void

Asserts that a directory exists and is writable.

Parameters

string $directory
string $message optional

Returns

void

Throws

ExpectationFailedException

assertDoesNotMatchRegularExpression() ¶ public static

assertDoesNotMatchRegularExpression(string $pattern, string $string, string $message = ''): void

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

Parameters

string $pattern
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

assertEmpty() ¶ public static

assertEmpty(mixed $actual, string $message = ''): void

Asserts that a variable is empty.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

GeneratorNotSupportedException

assertEquals() ¶ public static

assertEquals(mixed $expected, mixed $actual, string $message = ''): void

Asserts that two variables are equal.

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertEqualsCanonicalizing() ¶ public static

assertEqualsCanonicalizing(mixed $expected, mixed $actual, string $message = ''): void

Asserts that two variables are equal (canonicalizing).

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertEqualsIgnoringCase() ¶ public static

assertEqualsIgnoringCase(mixed $expected, mixed $actual, string $message = ''): void

Asserts that two variables are equal (ignoring case).

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertEqualsSql() ¶ public

assertEqualsSql(string $expected, string $actual, string $message = ''): void

Assert that a string matches SQL with db-specific characters like quotes removed.

Parameters

string $expected: The expected sql
string $actual: The sql to compare
string $message optional: The message to display on failure

Returns

void

assertEqualsWithDelta() ¶ public static

assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message = ''): void

Asserts that two variables are equal (with delta).

Parameters

mixed $expected
mixed $actual
float $delta
string $message optional

Returns

void

Throws

ExpectationFailedException

assertEventFired() ¶ public

assertEventFired(string $name, Cake\Event\EventManager|null $eventManager = null, string $message = ''): void

Asserts that a global event was fired. You must track events in your event manager for this assertion to work

Parameters

string $name: Event name
Cake\Event\EventManager|null $eventManager optional: Event manager to check, defaults to global event manager
string $message optional: Assertion failure message

Returns

void

assertEventFiredWith() ¶ public

assertEventFiredWith(string $name, string $dataKey, mixed $dataValue, Cake\Event\EventManager|null $eventManager = null, string $message = ''): void

Asserts an event was fired with data

If a third argument is passed, that value is used to compare with the value in $dataKey

Parameters

string $name: Event name
string $dataKey: Data key
mixed $dataValue: Data value
Cake\Event\EventManager|null $eventManager optional: Event manager to check, defaults to global event manager
string $message optional: Assertion failure message

Returns

void

assertFalse() ¶ public static

assertFalse(mixed $condition, string $message = ''): void

Asserts that a condition is false.

Parameters

mixed $condition
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileDoesNotExist() ¶ public static

assertFileDoesNotExist(string $filename, string $message = ''): void

Asserts that a file does not exist.

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileEquals() ¶ public static

assertFileEquals(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileEqualsCanonicalizing() ¶ public static

assertFileEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileEqualsIgnoringCase() ¶ public static

assertFileEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileExists() ¶ public static

assertFileExists(string $filename, string $message = ''): void

Asserts that a file exists.

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileIsNotReadable() ¶ public static

assertFileIsNotReadable(string $file, string $message = ''): void

Asserts that a file exists and is not readable.

Parameters

string $file
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileIsNotWritable() ¶ public static

assertFileIsNotWritable(string $file, string $message = ''): void

Asserts that a file exists and is not writable.

Parameters

string $file
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileIsReadable() ¶ public static

assertFileIsReadable(string $file, string $message = ''): void

Asserts that a file exists and is readable.

Parameters

string $file
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileIsWritable() ¶ public static

assertFileIsWritable(string $file, string $message = ''): void

Asserts that a file exists and is writable.

Parameters

string $file
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileMatchesFormat() ¶ public static

assertFileMatchesFormat(string $format, string $actualFile, string $message = ''): void

Asserts that a string matches a given format string.

Parameters

string $format
string $actualFile
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileMatchesFormatFile() ¶ public static

assertFileMatchesFormatFile(string $formatFile, string $actualFile, string $message = ''): void

Asserts that a string matches a given format string.

Parameters

string $formatFile
string $actualFile
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileNotEquals() ¶ public static

assertFileNotEquals(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileNotEqualsCanonicalizing() ¶ public static

assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFileNotEqualsIgnoringCase() ¶ public static

assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message = ''): void

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

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertFinite() ¶ public static

assertFinite(mixed $actual, string $message = ''): void

Asserts that a variable is finite.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertGreaterThan() ¶ public static

assertGreaterThan(mixed $minimum, mixed $actual, string $message = ''): void

Asserts that a value is greater than another value.

Parameters

mixed $minimum
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertGreaterThanOrEqual() ¶ public static

assertGreaterThanOrEqual(mixed $minimum, mixed $actual, string $message = ''): void

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

Parameters

mixed $minimum
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertHtml() ¶ public

assertHtml(array $expected, string $string, bool $fullDebug = false): bool

Asserts HTML tags.

Takes an array $expected and generates a regex from it to match the provided $string. Samples for $expected:

Checks for an input tag with a name attribute (contains any non-empty value) and an id attribute that contains 'my-input':

['input' => ['name', 'id' => 'my-input']]

Checks for two p elements with some text in them:

[
  ['p' => true],
  'textA',
  '/p',
  ['p' => true],
  'textB',
  '/p'
]

You can also specify a pattern expression as part of the attribute values, or the tag being defined, if you prepend the value with preg: and enclose it with slashes, like so:

[
  ['input' => ['name', 'id' => 'preg:/FieldName\d+/']],
  'preg:/My\s+field/'
]

Important: This function is very forgiving about whitespace and also accepts any permutation of attribute order. It will also allow whitespace between specified tags.

Parameters

array $expected: An array, see above
string $string: An HTML/XHTML/XML string
bool $fullDebug optional: Whether more verbose output should be used.

Returns

bool

assertInfinite() ¶ public static

assertInfinite(mixed $actual, string $message = ''): void

Asserts that a variable is infinite.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertInstanceOf() ¶ public static

assertInstanceOf(class-string<ExpectedType> $expected, mixed $actual, string $message = ''): void

Asserts that a variable is of a given type.

Templates


              ExpectedType
               of object

Parameters

class-string<ExpectedType> $expected
mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

UnknownClassOrInterfaceException

assertIsArray() ¶ public static

assertIsArray(mixed $actual, string $message = ''): void

Asserts that a variable is of type array.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsBool() ¶ public static

assertIsBool(mixed $actual, string $message = ''): void

Asserts that a variable is of type bool.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsCallable() ¶ public static

assertIsCallable(mixed $actual, string $message = ''): void

Asserts that a variable is of type callable.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsClosedResource() ¶ public static

assertIsClosedResource(mixed $actual, string $message = ''): void

Asserts that a variable is of type resource and is closed.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsFloat() ¶ public static

assertIsFloat(mixed $actual, string $message = ''): void

Asserts that a variable is of type float.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsInt() ¶ public static

assertIsInt(mixed $actual, string $message = ''): void

Asserts that a variable is of type int.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsIterable() ¶ public static

assertIsIterable(mixed $actual, string $message = ''): void

Asserts that a variable is of type iterable.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsList() ¶ public static

assertIsList(mixed $array, string $message = ''): void

Parameters

mixed $array
string $message optional

Returns

void

Throws

ExpectationFailedException

assertIsNotArray() ¶ public static

assertIsNotArray(mixed $actual, string $message = ''): void

Asserts that a variable is not of type array.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotBool() ¶ public static

assertIsNotBool(mixed $actual, string $message = ''): void

Asserts that a variable is not of type bool.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotCallable() ¶ public static

assertIsNotCallable(mixed $actual, string $message = ''): void

Asserts that a variable is not of type callable.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotClosedResource() ¶ public static

assertIsNotClosedResource(mixed $actual, string $message = ''): void

Asserts that a variable is not of type resource.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotFloat() ¶ public static

assertIsNotFloat(mixed $actual, string $message = ''): void

Asserts that a variable is not of type float.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotInt() ¶ public static

assertIsNotInt(mixed $actual, string $message = ''): void

Asserts that a variable is not of type int.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotIterable() ¶ public static

assertIsNotIterable(mixed $actual, string $message = ''): void

Asserts that a variable is not of type iterable.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotNumeric() ¶ public static

assertIsNotNumeric(mixed $actual, string $message = ''): void

Asserts that a variable is not of type numeric.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotObject() ¶ public static

assertIsNotObject(mixed $actual, string $message = ''): void

Asserts that a variable is not of type object.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotReadable() ¶ public static

assertIsNotReadable(string $filename, string $message = ''): void

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

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertIsNotResource() ¶ public static

assertIsNotResource(mixed $actual, string $message = ''): void

Asserts that a variable is not of type resource.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotScalar() ¶ public static

assertIsNotScalar(mixed $actual, string $message = ''): void

Asserts that a variable is not of type scalar.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotString() ¶ public static

assertIsNotString(mixed $actual, string $message = ''): void

Asserts that a variable is not of type string.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsNotWritable() ¶ public static

assertIsNotWritable(string $filename, string $message = ''): void

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

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertIsNumeric() ¶ public static

assertIsNumeric(mixed $actual, string $message = ''): void

Asserts that a variable is of type numeric.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsObject() ¶ public static

assertIsObject(mixed $actual, string $message = ''): void

Asserts that a variable is of type object.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsReadable() ¶ public static

assertIsReadable(string $filename, string $message = ''): void

Asserts that a file/dir is readable.

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertIsResource() ¶ public static

assertIsResource(mixed $actual, string $message = ''): void

Asserts that a variable is of type resource.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsScalar() ¶ public static

assertIsScalar(mixed $actual, string $message = ''): void

Asserts that a variable is of type scalar.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsString() ¶ public static

assertIsString(mixed $actual, string $message = ''): void

Asserts that a variable is of type string.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertIsWritable() ¶ public static

assertIsWritable(string $filename, string $message = ''): void

Asserts that a file/dir exists and is writable.

Parameters

string $filename
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJson() ¶ public static

assertJson(string $actual, string $message = ''): void

Asserts that a string is a valid JSON string.

Parameters

string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonFileEqualsJsonFile() ¶ public static

assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void

Asserts that two JSON files are equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonFileNotEqualsJsonFile() ¶ public static

assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message = ''): void

Asserts that two JSON files are not equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonStringEqualsJsonFile() ¶ public static

assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void

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

Parameters

string $expectedFile
string $actualJson
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonStringEqualsJsonString() ¶ public static

assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message = ''): void

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

Parameters

string $expectedJson
string $actualJson
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonStringNotEqualsJsonFile() ¶ public static

assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message = ''): void

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

Parameters

string $expectedFile
string $actualJson
string $message optional

Returns

void

Throws

ExpectationFailedException

assertJsonStringNotEqualsJsonString() ¶ public static

assertJsonStringNotEqualsJsonString(string $expectedJson, string $actualJson, string $message = ''): void

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

Parameters

string $expectedJson
string $actualJson
string $message optional

Returns

void

Throws

ExpectationFailedException

assertLessThan() ¶ public static

assertLessThan(mixed $maximum, mixed $actual, string $message = ''): void

Asserts that a value is smaller than another value.

Parameters

mixed $maximum
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertLessThanOrEqual() ¶ public static

assertLessThanOrEqual(mixed $maximum, mixed $actual, string $message = ''): void

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

Parameters

mixed $maximum
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertMatchesRegularExpression() ¶ public static

assertMatchesRegularExpression(string $pattern, string $string, string $message = ''): void

Asserts that a string matches a given regular expression.

Parameters

string $pattern
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNan() ¶ public static

assertNan(mixed $actual, string $message = ''): void

Asserts that a variable is nan.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotContains() ¶ public static

assertNotContains(mixed $needle, iterable<mixed> $haystack, string $message = ''): void

Asserts that a haystack does not contain a needle.

Parameters

mixed $needle
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertNotContainsEquals() ¶ public static

assertNotContainsEquals(mixed $needle, iterable<mixed> $haystack, string $message = ''): void

Parameters

mixed $needle
iterable<mixed> $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotContainsOnly() ¶ public static

assertNotContainsOnly(array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type, iterable<mixed> $haystack, ?bool $isNativeType = null, string $message = ''): void

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

Parameters

array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type
iterable<mixed> $haystack
?bool $isNativeType optional
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertNotCount() ¶ public static

assertNotCount(int $expectedCount, Countable|iterable<mixed> $haystack, string $message = ''): void

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

Parameters

int $expectedCount
Countable|iterable<mixed> $haystack
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

GeneratorNotSupportedException

assertNotEmpty() ¶ public static

assertNotEmpty(mixed $actual, string $message = ''): void

Asserts that a variable is not empty.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

GeneratorNotSupportedException

assertNotEquals() ¶ public static

assertNotEquals(mixed $expected, mixed $actual, string $message = ''): void

Asserts that two variables are not equal.

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotEqualsCanonicalizing() ¶ public static

assertNotEqualsCanonicalizing(mixed $expected, mixed $actual, string $message = ''): void

Asserts that two variables are not equal (canonicalizing).

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotEqualsIgnoringCase() ¶ public static

assertNotEqualsIgnoringCase(mixed $expected, mixed $actual, string $message = ''): void

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

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotEqualsWithDelta() ¶ public static

assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message = ''): void

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

Parameters

mixed $expected
mixed $actual
float $delta
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotFalse() ¶ public static

assertNotFalse(mixed $condition, string $message = ''): void

Asserts that a condition is not false.

Parameters

mixed $condition
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotInstanceOf() ¶ public static

assertNotInstanceOf(class-string<ExpectedType> $expected, mixed $actual, string $message = ''): void

Asserts that a variable is not of a given type.

Templates


              ExpectedType
               of object

Parameters

class-string<ExpectedType> $expected
mixed $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

assertNotNull() ¶ public static

assertNotNull(mixed $actual, string $message = ''): void

Asserts that a variable is not null.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotSame() ¶ public static

assertNotSame(mixed $expected, mixed $actual, string $message = ''): void

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.

Parameters

mixed $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotSameSize() ¶ public static

assertNotSameSize(Countable|iterable<mixed> $expected, Countable|iterable<mixed> $actual, string $message = ''): void

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

Parameters

Countable|iterable<mixed> $expected
Countable|iterable<mixed> $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

GeneratorNotSupportedException

assertNotTrue() ¶ public static

assertNotTrue(mixed $condition, string $message = ''): void

Asserts that a condition is not true.

Parameters

mixed $condition
string $message optional

Returns

void

Throws

ExpectationFailedException

assertNotWithinRange() ¶ protected static

assertNotWithinRange(float $expected, float $result, float $margin, string $message = ''): void

Compatibility function to test if a value is not between an acceptable range.

Parameters

float $expected
float $result
float $margin: the rage of acceptation
string $message optional: the text to display if the assertion is not correct

Returns

void

assertNull() ¶ public static

assertNull(mixed $actual, string $message = ''): void

Asserts that a variable is null.

Parameters

mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertObjectEquals() ¶ public static

assertObjectEquals(object $expected, object $actual, string $method = 'equals', string $message = ''): void

Parameters

object $expected
object $actual
string $method optional
string $message optional

Returns

void

Throws

ExpectationFailedException

assertObjectHasProperty() ¶ public static

assertObjectHasProperty(string $propertyName, object $object, string $message = ''): void

Asserts that an object has a specified property.

Parameters

string $propertyName
object $object
string $message optional

Returns

void

Throws

ExpectationFailedException

assertObjectNotEquals() ¶ public static

assertObjectNotEquals(object $expected, object $actual, string $method = 'equals', string $message = ''): void

Parameters

object $expected
object $actual
string $method optional
string $message optional

Returns

void

Throws

ExpectationFailedException

assertObjectNotHasProperty() ¶ public static

assertObjectNotHasProperty(string $propertyName, object $object, string $message = ''): void

Asserts that an object does not have a specified property.

Parameters

string $propertyName
object $object
string $message optional

Returns

void

Throws

ExpectationFailedException

assertPathEquals() ¶ protected static

assertPathEquals(string $expected, string $result, string $message = ''): void

Compatibility function to test paths.

Parameters

string $expected
string $result
string $message optional: the text to display if the assertion is not correct

Returns

void

assertPostConditions() ¶ protected

assertPostConditions(): void

This method is called between test and tearDown().

Gets the count of expectations on the mocks produced through Mockery.

Returns

void

assertPreConditions() ¶ protected

assertPreConditions(): void

Performs assertions shared by all tests of a test case.

This method is called between setUp() and test.

Returns

void

assertRegExpSql() ¶ public

assertRegExpSql(string $pattern, string $actual, bool $optional = false): void

Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters < and >. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries

Parameters

string $pattern: The expected sql pattern
string $actual: The sql to compare
bool $optional optional: Whether quote characters (marked with <>) are optional

Returns

void

assertSame() ¶ public static

assertSame(ExpectedType $expected, mixed $actual, string $message = ''): void

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

Templates


              ExpectedType

Parameters

ExpectedType $expected
mixed $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertSameSize() ¶ public static

assertSameSize(Countable|iterable<mixed> $expected, Countable|iterable<mixed> $actual, string $message = ''): void

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

Parameters

Countable|iterable<mixed> $expected
Countable|iterable<mixed> $actual
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

GeneratorNotSupportedException

assertStringContainsString() ¶ public static

assertStringContainsString(string $needle, string $haystack, string $message = ''): void

Parameters

string $needle
string $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringContainsStringIgnoringCase() ¶ public static

assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void

Parameters

string $needle
string $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringContainsStringIgnoringLineEndings() ¶ public static

assertStringContainsStringIgnoringLineEndings(string $needle, string $haystack, string $message = ''): void

Parameters

string $needle
string $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringEndsNotWith() ¶ public static

assertStringEndsNotWith(non-empty-string $suffix, string $string, string $message = ''): void

Asserts that a string ends not with a given suffix.

Parameters

non-empty-string $suffix
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

InvalidArgumentException

assertStringEndsWith() ¶ public static

assertStringEndsWith(non-empty-string $suffix, string $string, string $message = ''): void

Asserts that a string ends with a given suffix.

Parameters

non-empty-string $suffix
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

InvalidArgumentException

assertStringEqualsFile() ¶ public static

assertStringEqualsFile(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringEqualsFileCanonicalizing() ¶ public static

assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringEqualsFileIgnoringCase() ¶ public static

assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringEqualsStringIgnoringLineEndings() ¶ public static

assertStringEqualsStringIgnoringLineEndings(string $expected, string $actual, string $message = ''): void

Asserts that two strings are equal except for line endings.

Parameters

string $expected
string $actual
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringMatchesFormat() ¶ public static

assertStringMatchesFormat(string $format, string $string, string $message = ''): void

Asserts that a string matches a given format string.

Parameters

string $format
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringMatchesFormatFile() ¶ public static

assertStringMatchesFormatFile(string $formatFile, string $string, string $message = ''): void

Asserts that a string matches a given format file.

Parameters

string $formatFile
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringNotContainsString() ¶ public static

assertStringNotContainsString(string $needle, string $haystack, string $message = ''): void

Parameters

string $needle
string $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringNotContainsStringIgnoringCase() ¶ public static

assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message = ''): void

Parameters

string $needle
string $haystack
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringNotEqualsFile() ¶ public static

assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringNotEqualsFileCanonicalizing() ¶ public static

assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringNotEqualsFileIgnoringCase() ¶ public static

assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message = ''): void

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

Parameters

string $expectedFile
string $actualString
string $message optional

Returns

void

Throws

ExpectationFailedException

assertStringStartsNotWith() ¶ public static

assertStringStartsNotWith(non-empty-string $prefix, string $string, string $message = ''): void

Asserts that a string starts not with a given prefix.

Parameters

non-empty-string $prefix
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

InvalidArgumentException

assertStringStartsWith() ¶ public static

assertStringStartsWith(non-empty-string $prefix, string $string, string $message = ''): void

Asserts that a string starts with a given prefix.

Parameters

non-empty-string $prefix
string $string
string $message optional

Returns

void

Throws

ExpectationFailedException

InvalidArgumentException

assertTextContains() ¶ public

assertTextContains(string $needle, string $haystack, string $message = '', bool $ignoreCase = false): void

Assert that a string contains another string, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $needle: The string to search for.
string $haystack: The string to search through.
string $message optional: The message to display on failure.
bool $ignoreCase optional: Whether the search should be case-sensitive.

Returns

void

assertTextEndsNotWith() ¶ public

assertTextEndsNotWith(string $suffix, string $string, string $message = ''): void

Asserts that a string ends not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $suffix: The suffix to not find.
string $string: The string to search.
string $message optional: The message to use for failure.

Returns

void

assertTextEndsWith() ¶ public

assertTextEndsWith(string $suffix, string $string, string $message = ''): void

Asserts that a string ends with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $suffix: The suffix to find.
string $string: The string to search.
string $message optional: The message to use for failure.

Returns

void

assertTextEquals() ¶ public

assertTextEquals(string $expected, string $result, string $message = ''): void

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $expected: The expected value.
string $result: The actual value.
string $message optional: The message to use for failure.

Returns

void

assertTextNotContains() ¶ public

assertTextNotContains(string $needle, string $haystack, string $message = '', bool $ignoreCase = false): void

Assert that a text doesn't contain another text, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $needle: The string to search for.
string $haystack: The string to search through.
string $message optional: The message to display on failure.
bool $ignoreCase optional: Whether the search should be case-sensitive.

Returns

void

assertTextNotEquals() ¶ public

assertTextNotEquals(string $expected, string $result, string $message = ''): void

Assert text equality, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $expected: The expected value.
string $result: The actual value.
string $message optional: The message to use for failure.

Returns

void

assertTextStartsNotWith() ¶ public

assertTextStartsNotWith(string $prefix, string $string, string $message = ''): void

Asserts that a string starts not with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $prefix: The prefix to not find.
string $string: The string to search.
string $message optional: The message to use for failure.

Returns

void

assertTextStartsWith() ¶ public

assertTextStartsWith(string $prefix, string $string, string $message = ''): void

Asserts that a string starts with a given prefix, ignoring differences in newlines. Helpful for doing cross platform tests of blocks of text.

Parameters

string $prefix: The prefix to check for.
string $string: The string to search in.
string $message optional: The message to use for failure.

Returns

void

assertThat() ¶ public static

assertThat(mixed $value, Constraint $constraint, string $message = ''): void

Evaluates a PHPUnit\Framework\Constraint matcher object.

Parameters

mixed $value
Constraint $constraint
string $message optional

Returns

void

Throws

ExpectationFailedException

assertTrue() ¶ public static

assertTrue(mixed $condition, string $message = ''): void

Asserts that a condition is true.

Parameters

mixed $condition
string $message optional

Returns

void

Throws

ExpectationFailedException

assertWithinRange() ¶ protected static

assertWithinRange(float $expected, float $result, float $margin, string $message = ''): void

Compatibility function to test if a value is between an acceptable range.

Parameters

float $expected
float $result
float $margin: the rage of acceptation
string $message optional: the text to display if the assertion is not correct

Returns

void

assertXmlFileEqualsXmlFile() ¶ public static

assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void

Asserts that two XML files are equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Returns

void

Throws

Exception

ExpectationFailedException

XmlException

assertXmlFileNotEqualsXmlFile() ¶ public static

assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message = ''): void

Asserts that two XML files are not equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Returns

void

Throws

PHPUnit\Util\Exception

ExpectationFailedException

assertXmlStringEqualsXmlFile() ¶ public static

assertXmlStringEqualsXmlFile(string $expectedFile, string $actualXml, string $message = ''): void

Asserts that two XML documents are equal.

Parameters

string $expectedFile
string $actualXml
string $message optional

Returns

void

Throws

ExpectationFailedException

XmlException

assertXmlStringEqualsXmlString() ¶ public static

assertXmlStringEqualsXmlString(string $expectedXml, string $actualXml, string $message = ''): void

Asserts that two XML documents are equal.

Parameters

string $expectedXml
string $actualXml
string $message optional

Returns

void

Throws

ExpectationFailedException

XmlException

assertXmlStringNotEqualsXmlFile() ¶ public static

assertXmlStringNotEqualsXmlFile(string $expectedFile, string $actualXml, string $message = ''): void

Asserts that two XML documents are not equal.

Parameters

string $expectedFile
string $actualXml
string $message optional

Returns

void

Throws

ExpectationFailedException

XmlException

assertXmlStringNotEqualsXmlString() ¶ public static

assertXmlStringNotEqualsXmlString(string $expectedXml, string $actualXml, string $message = ''): void

Asserts that two XML documents are not equal.

Parameters

string $expectedXml
string $actualXml
string $message optional

Returns

void

Throws

ExpectationFailedException

XmlException

atLeast() ¶ protected

atLeast(int $requiredInvocations): InvokedAtLeastCountMatcher

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

Parameters

int $requiredInvocations

Returns

InvokedAtLeastCountMatcher

atLeastOnce() ¶ protected

atLeastOnce(): InvokedAtLeastOnceMatcher

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

Returns

InvokedAtLeastOnceMatcher

atMost() ¶ protected

atMost(int $allowedInvocations): InvokedAtMostCountMatcher

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

Parameters

int $allowedInvocations

Returns

InvokedAtMostCountMatcher

callback() ¶ public static

callback(callable(CallbackInput $callback): bool $callback): Callback<CallbackInput>

Templates


              CallbackInput
               of mixed

Parameters

callable(CallbackInput $callback): bool $callback

Returns

Callback<CallbackInput>

captureError() ¶ public

captureError(int $errorLevel, Closure $callable): Cake\Error\PhpError

Capture errors from $callable so that you can do assertions on the error.

If no error is captured an assertion will fail.

Parameters

int $errorLevel: The value of error_reporting() to use.
Closure $callable: A closure to capture errors from.

Returns

Cake\Error\PhpError

The captured error.

clearPlugins() ¶ public

clearPlugins(): void

Clear all plugins from the global plugin collection.

Useful in test case teardown methods.

Returns

void

containsEqual() ¶ public static

containsEqual(mixed $value): TraversableContainsEqual

Parameters

mixed $value

Returns

TraversableContainsEqual

containsIdentical() ¶ public static

containsIdentical(mixed $value): TraversableContainsIdentical

Parameters

mixed $value

Returns

TraversableContainsIdentical

containsOnly() ¶ public static

containsOnly(array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type): TraversableContainsOnly

Parameters

array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type

containsOnlyInstancesOf() ¶ public static

containsOnlyInstancesOf(class-string $className): TraversableContainsOnly

Parameters

class-string $className

countOf() ¶ public static

countOf(int $count): Count

Parameters

int $count

Returns

Count

createConfiguredMock() ¶ protected

createConfiguredMock(class-string<RealInstanceType> $type, array<non-empty-string, mixed> $configuration): MockObject&RealInstanceType

Creates (and configures) a mock object for the specified interface or class.

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $type
array<non-empty-string, mixed> $configuration

Returns

MockObject&RealInstanceType

Throws

InvalidArgumentException

MockObjectException

NoPreviousThrowableException

createConfiguredStub() ¶ protected static

createConfiguredStub(class-string<RealInstanceType> $type, array<non-empty-string, mixed> $configuration): RealInstanceType&Stub

Creates (and configures) a test stub for the specified interface or class.

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $type
array<non-empty-string, mixed> $configuration

Returns

RealInstanceType&Stub

Throws

InvalidArgumentException

MockObjectException

NoPreviousThrowableException

createMock() ¶ protected

createMock(class-string<RealInstanceType> $type): MockObject&RealInstanceType

Creates a mock object for the specified interface or class.

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $type

Returns

MockObject&RealInstanceType

Throws

InvalidArgumentException

MockObjectException

NoPreviousThrowableException

createMockForIntersectionOfInterfaces() ¶ protected

createMockForIntersectionOfInterfaces(list<class-string> $interfaces): MockObject

Parameters

list<class-string> $interfaces

Returns

MockObject

Throws

MockObjectException

createPartialMock() ¶ protected

createPartialMock(class-string<RealInstanceType> $type, list<non-empty-string> $methods): MockObject&RealInstanceType

Creates a partial mock object for the specified interface or class.

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $type
list<non-empty-string> $methods

Returns

MockObject&RealInstanceType

Throws

InvalidArgumentException

MockObjectException

createStub() ¶ protected static

createStub(class-string<RealInstanceType> $type): RealInstanceType&Stub

Creates a test stub for the specified interface or class.

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $type

Returns

RealInstanceType&Stub

Throws

InvalidArgumentException

MockObjectException

NoPreviousThrowableException

createStubForIntersectionOfInterfaces() ¶ protected static

createStubForIntersectionOfInterfaces(list<class-string> $interfaces): Stub

Parameters

list<class-string> $interfaces

deprecated() ¶ public

deprecated(Closure $callable, int $type = E_USER_DEPRECATED, string|null $phpVersion = null): void

Helper method for check deprecation methods

Parameters

Closure $callable: callable function that will receive asserts.
int $type optional: Error level to expect, E_DEPRECATED or E_USER_DEPRECATED.
string|null $phpVersion optional: If set, only applies to this version forward, e.g. 8.4.

Returns

void

directoryExists() ¶ public static

directoryExists(): DirectoryExists

Returns

DirectoryExists

doesNotPerformAssertions() ¶ public

doesNotPerformAssertions(): bool

Returns

bool

equalTo() ¶ public static

equalTo(mixed $value): IsEqual

Parameters

mixed $value

Returns

IsEqual

equalToCanonicalizing() ¶ public static

equalToCanonicalizing(mixed $value): IsEqualCanonicalizing

Parameters

mixed $value

Returns

IsEqualCanonicalizing

equalToIgnoringCase() ¶ public static

equalToIgnoringCase(mixed $value): IsEqualIgnoringCase

Parameters

mixed $value

Returns

IsEqualIgnoringCase

equalToWithDelta() ¶ public static

equalToWithDelta(mixed $value, float $delta): IsEqualWithDelta

Parameters

mixed $value
float $delta

Returns

IsEqualWithDelta

exactly() ¶ protected

exactly(int $count): InvokedCountMatcher

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

Parameters

int $count

Returns

InvokedCountMatcher

expectDeprecationMessageMatches() ¶ public

expectDeprecationMessageMatches(string $regex, Closure $callable): void

Parameters

string $regex: A regex to match against the deprecation message
Closure $callable: Callable which should trigger the warning

Returns

void

Throws

Exception

expectErrorHandlerMessageMatches() ¶ protected

expectErrorHandlerMessageMatches(string $regex, Closure $callable, int $errorLevel): void

Parameters

string $regex: A regex to match against the warning message
Closure $callable: Callable which should trigger the warning
int $errorLevel: The error level to listen to

Returns

void

Throws

Exception

expectErrorLog() ¶ protected

expectErrorLog(): void

Returns

void

expectErrorMessageMatches() ¶ public

expectErrorMessageMatches(string $regex, Closure $callable): void

Parameters

string $regex: A regex to match against the error message
Closure $callable: Callable which should trigger the warning

Returns

void

Throws

Exception

expectException() ¶ protected

expectException(class-string<Throwable> $exception): void

Parameters

class-string<Throwable> $exception

Returns

void

expectExceptionCode() ¶ protected

expectExceptionCode(int|string $code): void

Parameters

int|string $code

Returns

void

expectExceptionMessage() ¶ protected

expectExceptionMessage(string $message): void

Parameters

string $message

Returns

void

expectExceptionMessageMatches() ¶ protected

expectExceptionMessageMatches(string $regularExpression): void

Parameters

string $regularExpression

Returns

void

expectExceptionObject() ¶ protected

expectExceptionObject(Exception $exception): void

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

Parameters

Exception $exception

Returns

void

expectNotToPerformAssertions() ¶ protected

expectNotToPerformAssertions(): void

Returns

void

expectNoticeMessageMatches() ¶ public

expectNoticeMessageMatches(string $regex, Closure $callable): void

Parameters

string $regex: A regex to match against the warning message
Closure $callable: Callable which should trigger the warning

Returns

void

Throws

Exception

expectOutputRegex() ¶ protected

expectOutputRegex(string $expectedRegex): void

Parameters

string $expectedRegex

Returns

void

expectOutputString() ¶ protected

expectOutputString(string $expectedString): void

Parameters

string $expectedString

Returns

void

expectUserDeprecationMessage() ¶ protected

expectUserDeprecationMessage(non-empty-string $expectedUserDeprecationMessage): void

Parameters

non-empty-string $expectedUserDeprecationMessage

Returns

void

expectUserDeprecationMessageMatches() ¶ protected

expectUserDeprecationMessageMatches(non-empty-string $expectedUserDeprecationMessageRegularExpression): void

Parameters

non-empty-string $expectedUserDeprecationMessageRegularExpression

Returns

void

expectWarningMessageMatches() ¶ public

expectWarningMessageMatches(string $regex, Closure $callable): void

Parameters

string $regex: A regex to match against the warning message
Closure $callable: Callable which should trigger the warning

Returns

void

Throws

Exception

expectsOutput() ¶ public

expectsOutput(): bool

Returns

bool

fail() ¶ public static

fail(string $message = ''): never

Fails a test with the given message.

Parameters

string $message optional

Returns

never

Throws

AssertionFailedError

fetchTable() ¶ public

fetchTable(class-string<T>|string|null $alias = null, array<string, mixed> $options = []): $alias is class-string<T> ? T : \Cake\ORM\Table

Convenience method to get a table instance.

Templates


              T
               of \Cake\ORM\Table

Parameters

class-string<T>|string|null $alias optional: The alias name you want to get. Should be in CamelCase format. If null then the value of $defaultTable property is used.
array<string, mixed> $options optional: The options you want to build the table with. If a table has already been loaded the registry options will be ignored.

getCount() ¶ public static

getCount(): int

Return the current assertion count.

Returns

int

getFixtureStrategy() ¶ protected

getFixtureStrategy(): Cake\TestSuite\Fixture\FixtureStrategyInterface

Returns fixture strategy used by these tests.

Returns

Cake\TestSuite\Fixture\FixtureStrategyInterface

getFixtures() ¶ public

getFixtures(): array<string>

Get the fixtures this test should use.

Returns

array<string>

getMockBuilder() ¶ protected

getMockBuilder(class-string<RealInstanceType> $className): MockBuilder<RealInstanceType>

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

Templates


              RealInstanceType
               of object

Parameters

class-string<RealInstanceType> $className

Returns

MockBuilder<RealInstanceType>

getMockForModel() ¶ public

getMockForModel(string $alias, array<string> $methods = [], array<string, mixed> $options = []): Cake\ORM\Table|PHPUnit\Framework\MockObject\MockObject

Mock a model, maintain fixtures and table association

Parameters

string $alias: The model to get a mock for.
array<string> $methods optional: The list of methods to mock
array<string, mixed> $options optional: The config data for the mock's constructor.

Returns

Cake\ORM\Table|PHPUnit\Framework\MockObject\MockObject

Throws

Cake\ORM\Exception\MissingTableClassException

getTableLocator() ¶ public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Gets the table locator.

Returns

Cake\ORM\Locator\LocatorInterface

greaterThan() ¶ public static

greaterThan(mixed $value): GreaterThan

Parameters

mixed $value

Returns

GreaterThan

greaterThanOrEqual() ¶ public static

greaterThanOrEqual(mixed $value): LogicalOr

Parameters

mixed $value

Returns

LogicalOr

groups() ¶ public

groups(): list<string>

Returns

list<string>

hasDependencyInput() ¶ public

hasDependencyInput(): bool

Returns

bool

hasUnexpectedOutput() ¶ public

hasUnexpectedOutput(): bool

Returns

bool

identicalTo() ¶ public static

identicalTo(mixed $value): IsIdentical

Parameters

mixed $value

Returns

IsIdentical

isArray() ¶ public static

isArray(): IsType

Returns

IsType

isBool() ¶ public static

isBool(): IsType

Returns

IsType

isCallable() ¶ public static

isCallable(): IsType

Returns

IsType

isClosedResource() ¶ public static

isClosedResource(): IsType

Returns

IsType

isEmpty() ¶ public static

isEmpty(): IsEmpty

Returns

IsEmpty

isFalse() ¶ public static

isFalse(): IsFalse

Returns

IsFalse

isFinite() ¶ public static

isFinite(): IsFinite

Returns

IsFinite

isFloat() ¶ public static

isFloat(): IsType

Returns

IsType

isInfinite() ¶ public static

isInfinite(): IsInfinite

Returns

IsInfinite

isInstanceOf() ¶ public static

isInstanceOf(string $className): IsInstanceOf

Parameters

string $className

isType() ¶ public static

isType(array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type): IsType

Parameters

array|bool|boolean|callable|double|float|int|integer|iterable|null|numeric|object|real|resource (closed)|resource|scalar|string $type

Returns

IsType

Throws

UnknownNativeTypeException

isWritable() ¶ public static

isWritable(): IsWritable

Returns

IsWritable

lessThan() ¶ public static

lessThan(mixed $value): LessThan

Parameters

mixed $value

Returns

LessThan

lessThanOrEqual() ¶ public static

lessThanOrEqual(mixed $value): LogicalOr

Parameters

mixed $value

Returns

LogicalOr

loadPlugins() ¶ public

loadPlugins(array $plugins = []): Cake\Http\BaseApplication

Load plugins into a simulated application.

Useful to test how plugins being loaded/not loaded interact with other elements in CakePHP or applications.

Parameters

array $plugins optional: List of Plugins to load.

Returns

Cake\Http\BaseApplication

loadRoutes() ¶ public

loadRoutes(array|null $appArgs = null): void

Load routes for the application.

If no application class can be found an exception will be raised. Routes for plugins will not be loaded. Use loadPlugins() or use Cake\TestSuite\IntegrationTestCaseTrait to better simulate all routes and plugins being loaded.

Parameters

array|null $appArgs optional: Constructor parameters for the application class.

Returns

void

logicalAnd() ¶ public static

logicalAnd(mixed ...$constraints): LogicalAnd

Parameters

mixed ...$constraints

Returns

LogicalAnd

Throws

Exception

logicalNot() ¶ public static

logicalNot(Constraint $constraint): LogicalNot

Parameters

Constraint $constraint

Returns

LogicalNot

logicalOr() ¶ public static

logicalOr(mixed ...$constraints): LogicalOr

Parameters

mixed ...$constraints

Returns

LogicalOr

logicalXor() ¶ public static

logicalXor(mixed ...$constraints): LogicalXor

Parameters

mixed ...$constraints

Returns

LogicalXor

markTestIncomplete() ¶ public static

markTestIncomplete(string $message = ''): never

Mark the test as incomplete.

Parameters

string $message optional

Returns

never

Throws

IncompleteTestError

markTestSkipped() ¶ public static

markTestSkipped(string $message = ''): never

Mark the test as skipped.

Parameters

string $message optional

Returns

never

Throws

SkippedWithMessageException

matches() ¶ public static

matches(string $string): StringMatchesFormatDescription

Parameters

string $string

Returns

StringMatchesFormatDescription

matchesRegularExpression() ¶ public static

matchesRegularExpression(string $pattern): RegularExpression

Parameters

string $pattern

Returns

RegularExpression

name() ¶ public

name(): non-empty-string

Returns

non-empty-string

nameWithDataSet() ¶ public

nameWithDataSet(): string

Returns

string

never() ¶ protected

never(): InvokedCountMatcher

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

Returns

InvokedCountMatcher

numberOfAssertionsPerformed() ¶ public

numberOfAssertionsPerformed(): 0|positive-int

Returns

0|positive-int

objectEquals() ¶ public static

objectEquals(object $object, string $method = 'equals'): ObjectEquals

Parameters

object $object
string $method optional

Returns

ObjectEquals

onNotSuccessfulTest() ¶ protected

onNotSuccessfulTest(Throwable $t): never

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

Parameters

Throwable $t

Returns

never

Throws

Throwable

once() ¶ protected

once(): InvokedCountMatcher

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

Returns

InvokedCountMatcher

output() ¶ public

output(): string

Returns

string

provideAdditionalInformation() ¶ protected

provideAdditionalInformation(non-empty-string $additionalInformation): void

Parameters

non-empty-string $additionalInformation

Returns

void

providedData() ¶ public

providedData(): array<mixed>

Returns

array<mixed>

provides() ¶ public

provides(): list<ExecutionOrderDependency>

Returns

list<ExecutionOrderDependency>

registerComparator() ¶ protected

registerComparator(Comparator $comparator): void

Parameters

Comparator $comparator

Returns

void

registerFailureType() ¶ protected

registerFailureType(class-string $classOrInterface): void

Parameters

class-string $classOrInterface

Returns

void

registerMockObject() ¶ public

registerMockObject(MockObject $mockObject): void

Parameters

MockObject $mockObject

Returns

void

removePlugins() ¶ public

removePlugins(array<string> $names = []): void

Remove plugins from the global plugin collection.

Useful in test case teardown methods.

Parameters

array<string> $names optional: A list of plugins you want to remove.

Returns

void

requires() ¶ public

requires(): list<ExecutionOrderDependency>

Returns

list<ExecutionOrderDependency>

resetCount() ¶ public static

resetCount(): void

Reset the assertion counter.

Returns

void

result() ¶ public

result(): mixed

Returns

mixed

run() ¶ public

run(): void

Returns

void

Throws

PHPUnit\Runner\Exception

PHPUnit\Util\Exception

SebastianBergmann\CodeCoverage\InvalidArgumentException

SebastianBergmann\Template\InvalidArgumentException

Exception

NoPreviousThrowableException

ProcessIsolationException

UnintentionallyCoveredCodeException

runBare() ¶ public

runBare(): void

Returns

void

Throws

Throwable

setAppNamespace() ¶ public static

setAppNamespace(string $appNamespace = 'TestApp'): string|null

Set the app namespace

Parameters

string $appNamespace optional: The app namespace, defaults to "TestApp".

Returns

string|null

The previous app namespace or null if not set.

setBackupGlobals() ¶ public

setBackupGlobals(bool $backupGlobals): void

Parameters

bool $backupGlobals

Returns

void

setBackupGlobalsExcludeList() ¶ public

setBackupGlobalsExcludeList(list<string> $backupGlobalsExcludeList): void

Parameters

list<string> $backupGlobalsExcludeList

Returns

void

setBackupStaticProperties() ¶ public

setBackupStaticProperties(bool $backupStaticProperties): void

Parameters

bool $backupStaticProperties

Returns

void

setBackupStaticPropertiesExcludeList() ¶ public

setBackupStaticPropertiesExcludeList(array<string, list<class-string>> $backupStaticPropertiesExcludeList): void

Parameters

array<string, list<class-string>> $backupStaticPropertiesExcludeList

Returns

void

setData() ¶ public

setData(int|string $dataName, array<mixed> $data): void

Parameters

int|string $dataName
array<mixed> $data

Returns

void

setDependencies() ¶ public

setDependencies(list<ExecutionOrderDependency> $dependencies): void

Parameters

list<ExecutionOrderDependency> $dependencies

Returns

void

setDependencyInput() ¶ public

setDependencyInput(array<non-empty-string, array<mixed>> $dependencyInput): void

Parameters

array<non-empty-string, array<mixed>> $dependencyInput

Returns

void

setGroups() ¶ public

setGroups(list<string> $groups): void

Parameters

list<string> $groups

Returns

void

setInIsolation() ¶ public

setInIsolation(bool $inIsolation): void

Parameters

bool $inIsolation

Returns

void

setPreserveGlobalState() ¶ public

setPreserveGlobalState(bool $preserveGlobalState): void

Parameters

bool $preserveGlobalState

Returns

void

setResult() ¶ public

setResult(mixed $result): void

Parameters

mixed $result

Returns

void

setRunClassInSeparateProcess() ¶ public

setRunClassInSeparateProcess(bool $runClassInSeparateProcess): void

Parameters

bool $runClassInSeparateProcess

Returns

void

setRunTestInSeparateProcess() ¶ public

setRunTestInSeparateProcess(bool $runTestInSeparateProcess): void

Parameters

bool $runTestInSeparateProcess

Returns

void

setTableLocator() ¶ public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator: LocatorInterface instance.

Returns

$this

setUp() ¶ protected

setUp(): void

Setup the test case, backup the static object values so they can be restored. Specifically backs up the contents of Configure and paths in App if they have not already been backed up.

Returns

void

setUpBeforeClass() ¶ public static

setUpBeforeClass(): void

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

Returns

void

setupFixtures() ¶ protected

setupFixtures(): void

Initialized and loads any use fixtures.

Returns

void

size() ¶ public

size(): TestSize

Returns

TestSize

skipIf() ¶ public

skipIf(bool $shouldSkip, string $message = ''): bool

Overrides SimpleTestCase::skipIf to provide a boolean return value

Parameters

bool $shouldSkip: Whether the test should be skipped.
string $message optional: The message to display.

Returns

bool

skipUnless() ¶ protected

skipUnless(bool $condition, string $message = ''): bool

Compatibility function for skipping.

Parameters

bool $condition: Condition to trigger skipping
string $message optional: Message for skip

Returns

bool

sortId() ¶ public

sortId(): string

Returns

string

status() ¶ public

status(): TestStatus

Returns

TestStatus

stringContains() ¶ public static

stringContains(string $string, bool $case = true): StringContains

Parameters

string $string
bool $case optional

Returns

StringContains

stringEndsWith() ¶ public static

stringEndsWith(non-empty-string $suffix): StringEndsWith

Parameters

non-empty-string $suffix

Returns

StringEndsWith

Throws

InvalidArgumentException

stringEqualsStringIgnoringLineEndings() ¶ public static

stringEqualsStringIgnoringLineEndings(string $string): StringEqualsStringIgnoringLineEndings

Parameters

string $string

Returns

StringEqualsStringIgnoringLineEndings

stringStartsWith() ¶ public static

stringStartsWith(non-empty-string $prefix): StringStartsWith

Parameters

non-empty-string $prefix

throwException(Throwable $exception): ExceptionStub

Parameters

Throwable $exception

Returns

ExceptionStub

toString() ¶ public

toString(): string

Returns a string representation of the test case.

Returns

string

Throws

Exception

transformException() ¶ protected

transformException(Throwable $t): Throwable

Parameters

Throwable $t

Returns

Throwable

usesDataProvider() ¶ public

usesDataProvider(): bool

Returns

bool

valueObjectForEvents() ¶ public

valueObjectForEvents(): Event\Code\TestMethod

Returns

Event\Code\TestMethod

wasPrepared() ¶ public

wasPrepared(): bool

Returns

bool

withConsecutive() ¶ public static

withConsecutive(array $firstCallArguments, array ...$consecutiveCallsArguments): iterable

Parameters

array $firstCallArguments: The call arguments
array ...$consecutiveCallsArguments: Additional arguments

Returns

iterable

withErrorReporting() ¶ public

withErrorReporting(int $errorLevel, callable $callable): void

Helper method for tests that needs to use error_reporting()

Parameters

int $errorLevel: value of error_reporting() that needs to use
callable $callable: callable function that will receive asserts

Returns

void

Property Detail

`$fixtureStrategy` ¶ protected

Type

Cake\TestSuite\Fixture\FixtureStrategyInterface|null

`$fixtures` ¶ protected

Fixtures used by this test case.

Type

array<string>

Namespaces

Class TestCase

Property Summary

Method Summary

__construct() public

_assertAttributes() protected

_getTableClassName() protected

_normalizePath() protected

addFixture() protected

addToAssertionCount() public

any() protected

anything() public static

arrayHasKey() public static

assertArrayHasKey() public static

assertArrayIsEqualToArrayIgnoringListOfKeys() public static

assertArrayIsEqualToArrayOnlyConsideringListOfKeys() public static

assertArrayIsIdenticalToArrayIgnoringListOfKeys() public static

assertArrayIsIdenticalToArrayOnlyConsideringListOfKeys() public static

assertArrayNotHasKey() public static

assertContains() public static

assertContainsEquals() public static

assertContainsNotOnlyArray() public static

assertContainsNotOnlyBool() public static

assertContainsNotOnlyCallable() public static

assertContainsNotOnlyClosedResource() public static

assertContainsNotOnlyFloat() public static

assertContainsNotOnlyInstancesOf() public static

assertContainsNotOnlyInt() public static

assertContainsNotOnlyIterable() public static

assertContainsNotOnlyNull() public static

assertContainsNotOnlyNumeric() public static

assertContainsNotOnlyObject() public static

assertContainsNotOnlyResource() public static

assertContainsNotOnlyScalar() public static

assertContainsNotOnlyString() public static

assertContainsOnly() public static deprecated

assertContainsOnlyArray() public static

assertContainsOnlyBool() public static

assertContainsOnlyCallable() public static

assertContainsOnlyClosedResource() public static

assertContainsOnlyFloat() public static

assertContainsOnlyInstancesOf() public static

assertContainsOnlyInt() public static

assertContainsOnlyIterable() public static

assertContainsOnlyNull() public static

assertContainsOnlyNumeric() public static

assertContainsOnlyObject() public static

assertContainsOnlyResource() public static

assertContainsOnlyScalar() public static

assertContainsOnlyString() public static

assertCount() public static

assertDirectoryDoesNotExist() public static

assertDirectoryExists() public static

assertDirectoryIsNotReadable() public static

assertDirectoryIsNotWritable() public static

assertDirectoryIsReadable() public static

assertDirectoryIsWritable() public static

assertDoesNotMatchRegularExpression() public static

assertEmpty() public static

assertEquals() public static

assertEqualsCanonicalizing() public static

assertEqualsIgnoringCase() public static

assertEqualsSql() public

assertEqualsWithDelta() public static

assertEventFired() public

assertEventFiredWith() public

assertFalse() public static

assertFileDoesNotExist() public static

assertFileEquals() public static

assertFileEqualsCanonicalizing() public static

assertFileEqualsIgnoringCase() public static

assertFileExists() public static

assertFileIsNotReadable() public static

assertFileIsNotWritable() public static

assertFileIsReadable() public static

assertFileIsWritable() public static

assertFileMatchesFormat() public static

assertFileMatchesFormatFile() public static

assertFileNotEquals() public static

assertFileNotEqualsCanonicalizing() public static