Class IntegrationTestCase

A test case class intended to make integration tests of your controllers easier.

This test class provides a number of helper methods and features that make dispatching requests and checking their responses simpler. It favours full integration tests over mock objects as you can test more of your code easily and avoid some of the maintenance pitfalls that mock objects create.

Abstract
Namespace: Cake\TestSuite

Properties summary

  • $_appArgs protected
    array|null

    The customized application constructor arguments.

  • $_appClass protected
    string|null

    The customized application class name.

  • $_configure protected
    array

    Configure values to restore at end of test.

  • $_controller protected
    \Cake\Controller\Controller

    The controller used in the last request.

  • $_cookie protected
    array

    Cookie data to use in the next request.

  • string|null
  • $_csrfToken protected
    bool

    Boolean flag for whether or not the request should have a CSRF token added.

  • $_exception protected
    \Throwable|null

    The exception being thrown if the case.

  • $_flashMessages protected
    array|null

    Stored flash messages before render

  • $_layoutName protected
    string

    The last rendered layout

  • $_request protected
    array

    The data used to build the next request.

  • $_requestSession protected
    \Cake\Http\Session

    The session instance from the last request

  • $_response protected
    \Psr\Http\Message\ResponseInterface

    The response for the most recent request.

  • bool

    Boolean flag for whether or not the request should re-store flash messages

  • $_securityToken protected
    bool

    Boolean flag for whether or not the request should have a SecurityComponent token added.

  • $_session protected
    array

    Session data to use in the next request.

  • $_tableLocator protected
    \Cake\ORM\Locator\LocatorInterface|null

    Table locator instance

  • $_unlockedFields protected
    string[]

    List of fields that are excluded from field validation.

  • $_validCiphers protected
    string[]

    Valid cipher names for encrypted cookies.

  • $_viewName protected
    string

    The last rendered view

  • $autoFixtures public
    bool

    By default, all fixtures attached to this class will be truncated and reloaded after each test.

  • $backupGlobals protected
    ?bool
  • string[]
  • bool
  • array<string,array<int,string>>
  • $dropTables public
    bool

    Control table create/drops on each test method.

  • \Cake\TestSuite\Fixture\FixtureManager|null

    The class responsible for managing the creation, loading and removing of fixtures

  • $fixtures protected
    string[]

    Fixtures used by this test case.

  • bool
  • bool

Method Summary

Method Detail

__construct() public

__construct(mixed $name, array $data, mixed $dataName)

Parameters

string $name optional
array $data optional
string $dataName optional

_addTokens() protected

_addTokens(string $url, array $data)

Add the CSRF and Security Component tokens if necessary.

Parameters

string $url

The URL the form is being submitted on.

array $data

The request body data.

Returns

array

The request body with tokens added.

_assertAttributes() protected

_assertAttributes(array $assertions, string $string, bool $fullDebug, mixed $regex)

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

Parameters

array $assertions

Assertions to run.

string $string

The HTML string to check.

bool $fullDebug optional

Whether or not more verbose output should be used.

array|string $regex optional

Full regexp from assertHtml

Returns

string|false

_buildRequest() protected

_buildRequest(string $url, mixed $method, mixed $data)

Creates a request object with the configured options and parameters.

Parameters

string $url

The URL

string $method

The HTTP method

string|array $data optional

The request data.

Returns

array

The request context

_castToString() protected

_castToString(array $data)

Recursively casts all data to string as that is how data would be POSTed in the real world

Parameters

array $data

POST data

Returns

array

_checkCipher() protected

_checkCipher(string $encrypt)

Helper method for validating encryption cipher names.

Parameters

string $encrypt

The cipher name.

Throws

RuntimeException
When an invalid cipher is provided.

_decode() protected

_decode(string $value, mixed $encrypt, ?string $key)

Decodes and decrypts a single value.

Parameters

string $value

The value to decode & decrypt.

string|false $encrypt

The encryption cipher to use.

string|null $key

Used as the security salt if specified.

Returns

string|array

Decoded values.

_decrypt() protected

_decrypt(mixed $values, mixed $mode, ?string $key)

Decrypts $value using public $type method in Security class

Parameters

string[]|string $values

Values to decrypt

string|false $mode

Encryption mode

string|null $key optional

Used as the security salt if specified.

Returns

string|array

Decrypted values

_encrypt() protected

_encrypt(mixed $value, mixed $encrypt, ?string $key)

Encrypts $value using public $type method in Security class

Parameters

string|array $value

Value to encrypt

string|false $encrypt

Encryption mode to use. False disabled encryption.

string|null $key optional

Used as the security salt if specified.

Returns

string

Encoded values

_explode() protected

_explode(string $string)

Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().

Parameters

string $string

A string containing JSON encoded data, or a bare string.

Returns

string|array

Map of key and values

_getBodyAsString() protected

_getBodyAsString()

Get the response body as string

Returns

string

The response body.

_getCookieEncryptionKey() protected

_getCookieEncryptionKey()

Returns the encryption key to be used.

Returns

string

_getTableClassName() protected

_getTableClassName(string $alias, array $options)

Gets the class name for the table.

Parameters

string $alias

The model to get a mock for.

array $options

The config data for the mock's constructor.

Returns

string

Throws

Cake\ORM\Exception\MissingTableClassException

_handleError() protected

_handleError(\Throwable $exception)

Attempts to render an error response for a given exception.

This method will attempt to use the configured exception renderer. If that class does not exist, the built-in renderer will be used.

Parameters

\Throwable $exception

Exception to handle.

_implode() protected

_implode(array $array)

Implode method to keep keys are multidimensional arrays

Parameters

array $array

Map of key and values

Returns

string

A JSON encoded string.

_makeDispatcher() protected

_makeDispatcher()

Get the correct dispatcher instance.

Returns

\Cake\TestSuite\MiddlewareDispatcher

A dispatcher instance

_normalizePath() protected

_normalizePath(string $path)

Normalize a path for comparison.

Parameters

string $path

Path separated by "/" slash.

Returns

string

Normalized path separated by DIRECTORY_SEPARATOR.

_sendRequest() protected

_sendRequest(mixed $url, mixed $method, mixed $data)

Creates and send the request into a Dispatcher instance.

Receives and stores the response for future inspection.

Parameters

string|array $url

The URL

string $method

The HTTP method

string|array $data optional

The request data.

Throws

PHPUnit\Exception|\Throwable

_url() protected

_url(string $url)

Creates a valid request url and parameter array more like Request::_url()

Parameters

string $url

The URL

Returns

array

Qualified URL, the query parameters, and host data

addFixture() protected

addFixture(string $fixture)

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)

Parameters

int $count

addWarning() public

addWarning(string $warning)

Parameters

string $warning

any() public static

any()

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

anything() public static

anything()

arrayHasKey() public static

arrayHasKey(mixed $key)

Parameters

int|string $key

assertArrayHasKey() public static

assertArrayHasKey(mixed $key, mixed $array, string $message)

Asserts that an array has a specified key.

Parameters

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertArrayNotHasKey() public static

assertArrayNotHasKey(mixed $key, mixed $array, string $message)

Asserts that an array does not have a specified key.

Parameters

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertArraySubset() public static

assertArraySubset(mixed $subset, mixed $array, bool $checkForObjectIdentity, string $message)

Asserts that an array has a specified subset.

Parameters

array|\ArrayAccess $subset
array|\ArrayAccess $array
bool $checkForObjectIdentity optional
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeContains() public static

assertAttributeContains(mixed $needle, string $haystackAttributeName, mixed $haystackClassOrObject, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)

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

Parameters

mixed $needle
string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeContainsOnly() public static

assertAttributeContainsOnly(string $type, string $haystackAttributeName, mixed $haystackClassOrObject, ?bool $isNativeType, string $message)

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

Parameters

string $type
string $haystackAttributeName
object|string $haystackClassOrObject
bool $isNativeType optional
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeCount() public static

assertAttributeCount(int $expectedCount, string $haystackAttributeName, mixed $haystackClassOrObject, string $message)

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

Parameters

int $expectedCount
string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeEmpty() public static

assertAttributeEmpty(string $haystackAttributeName, mixed $haystackClassOrObject, string $message)

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

Parameters

string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeEquals() public static

assertAttributeEquals(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeGreaterThan() public static

assertAttributeGreaterThan(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

Asserts that an attribute is greater than another value.

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeGreaterThanOrEqual() public static

assertAttributeGreaterThanOrEqual(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeInstanceOf() public static

assertAttributeInstanceOf(string $expected, string $attributeName, mixed $classOrObject, string $message)

Asserts that an attribute is of a given type.

Parameters

string $expected
string $attributeName
object|string $classOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeInternalType() public static

assertAttributeInternalType(string $expected, string $attributeName, mixed $classOrObject, string $message)

Asserts that an attribute is of a given type.

Parameters

string $expected
string $attributeName
object|string $classOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeLessThan() public static

assertAttributeLessThan(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

Asserts that an attribute is smaller than another value.

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeLessThanOrEqual() public static

assertAttributeLessThanOrEqual(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotContains() public static

assertAttributeNotContains(mixed $needle, string $haystackAttributeName, mixed $haystackClassOrObject, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)

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

Parameters

mixed $needle
string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotContainsOnly() public static

assertAttributeNotContainsOnly(string $type, string $haystackAttributeName, mixed $haystackClassOrObject, ?bool $isNativeType, string $message)

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

Parameters

string $type
string $haystackAttributeName
object|string $haystackClassOrObject
bool $isNativeType optional
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotCount() public static

assertAttributeNotCount(int $expectedCount, string $haystackAttributeName, mixed $haystackClassOrObject, string $message)

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

Parameters

int $expectedCount
string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotEmpty() public static

assertAttributeNotEmpty(string $haystackAttributeName, mixed $haystackClassOrObject, string $message)

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

Parameters

string $haystackAttributeName
object|string $haystackClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotEquals() public static

assertAttributeNotEquals(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotInstanceOf() public static

assertAttributeNotInstanceOf(string $expected, string $attributeName, mixed $classOrObject, string $message)

Asserts that an attribute is of a given type.

Parameters

string $expected
string $attributeName
object|string $classOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotInternalType() public static

assertAttributeNotInternalType(string $expected, string $attributeName, mixed $classOrObject, string $message)

Asserts that an attribute is of a given type.

Parameters

string $expected
string $attributeName
object|string $classOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeNotSame() public static

assertAttributeNotSame(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertAttributeSame() public static

assertAttributeSame(mixed $expected, string $actualAttributeName, mixed $actualClassOrObject, string $message)

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

Parameters

mixed $expected
string $actualAttributeName
object|string $actualClassOrObject
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertClassHasAttribute() public static

assertClassHasAttribute(string $attributeName, string $className, string $message)

Asserts that a class has a specified attribute.

Parameters

string $attributeName
string $className
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertClassHasStaticAttribute() public static

assertClassHasStaticAttribute(string $attributeName, string $className, string $message)

Asserts that a class has a specified static attribute.

Parameters

string $attributeName
string $className
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertClassNotHasAttribute() public static

assertClassNotHasAttribute(string $attributeName, string $className, string $message)

Asserts that a class does not have a specified attribute.

Parameters

string $attributeName
string $className
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertClassNotHasStaticAttribute() public static

assertClassNotHasStaticAttribute(string $attributeName, string $className, string $message)

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

Parameters

string $attributeName
string $className
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertContains() public static

assertContains(mixed $needle, mixed $haystack, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)

Asserts that a haystack contains a needle.

Parameters

mixed $needle
mixed $haystack
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertContainsEquals() public static

assertContainsEquals(mixed $needle, iterable $haystack, string $message)

Parameters

mixed $needle
iterable $haystack
string $message optional

assertContainsOnly() public static

assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType, string $message)

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

Parameters

string $type
iterable $haystack
?bool $isNativeType optional
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertContainsOnlyInstancesOf() public static

assertContainsOnlyInstancesOf(string $className, iterable $haystack, string $message)

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

Parameters

string $className
iterable $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertContentType() public

assertContentType(string $type, string $message)

Asserts content type

Parameters

string $type

The content-type to check for.

string $message optional

The failure message that will be appended to the generated message.

assertCookie() public

assertCookie(mixed $expected, string $name, string $message)

Asserts cookie values

Parameters

mixed $expected

The expected contents.

string $name

The cookie name.

string $message optional

The failure message that will be appended to the generated message.

assertCookieEncrypted() public

assertCookieEncrypted(mixed $expected, string $name, string $encrypt, ?string $key, string $message)

Asserts cookie values which are encrypted by the CookieComponent.

The difference from assertCookie() is this decrypts the cookie value like the CookieComponent for this assertion.

Parameters

mixed $expected

The expected contents.

string $name

The cookie name.

string $encrypt optional

Encryption mode to use.

string|null $key optional

Encryption key used. Defaults to Security.salt.

string $message optional

The failure message that will be appended to the generated message.

See Also

\Cake\Utility\CookieCryptTrait::_encrypt()

assertCookieNotSet() public

assertCookieNotSet(string $cookie, string $message)

Asserts a cookie has not been set in the response

Parameters

string $cookie

The cookie name to check

string $message optional

The failure message that will be appended to the generated message.

assertCount() public static

assertCount(int $expectedCount, mixed $haystack, string $message)

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

Parameters

int $expectedCount
\Countable|iterable $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertDirectoryExists() public static

assertDirectoryExists(string $directory, string $message)

Asserts that a directory exists.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertDirectoryIsReadable() public static

assertDirectoryIsReadable(string $directory, string $message)

Asserts that a directory exists and is readable.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertDirectoryIsWritable() public static

assertDirectoryIsWritable(string $directory, string $message)

Asserts that a directory exists and is writable.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertDirectoryNotExists() public static

assertDirectoryNotExists(string $directory, string $message)

Asserts that a directory does not exist.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertDirectoryNotIsReadable() public static

assertDirectoryNotIsReadable(string $directory, string $message)

Asserts that a directory exists and is not readable.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertDirectoryNotIsWritable() public static

assertDirectoryNotIsWritable(string $directory, string $message)

Asserts that a directory exists and is not writable.

Parameters

string $directory
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEmpty() public static

assertEmpty(mixed $actual, string $message)

Asserts that a variable is empty.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEqualXMLStructure() public static

assertEqualXMLStructure(\DOMElement $expectedElement, \DOMElement $actualElement, bool $checkAttributes, string $message)

Asserts that a hierarchy of DOMElements matches.

Parameters

\DOMElement $expectedElement
\DOMElement $actualElement
bool $checkAttributes optional
string $message optional

Throws

PHPUnit\Framework\AssertionFailedError

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEquals() public static

assertEquals(mixed $expected, mixed $actual, string $message, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)

Asserts that two variables are equal.

Parameters

mixed $expected
mixed $actual
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEqualsCanonicalizing() public static

assertEqualsCanonicalizing(mixed $expected, mixed $actual, string $message)

Asserts that two variables are equal (canonicalizing).

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEqualsIgnoringCase() public static

assertEqualsIgnoringCase(mixed $expected, mixed $actual, string $message)

Asserts that two variables are equal (ignoring case).

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEqualsSql() public

assertEqualsSql(string $expected, string $actual, string $message)

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

assertEqualsWithDelta() public static

assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message)

Asserts that two variables are equal (with delta).

Parameters

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertEventFired() public

assertEventFired(string $name, ?\Cake\Event\EventManager $eventManager, string $message)

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

assertEventFiredWith() public

assertEventFiredWith(string $name, string $dataKey, mixed $dataValue, ?\Cake\Event\EventManager $eventManager, string $message)

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

assertFalse() public static

assertFalse(mixed $condition, string $message)

Asserts that a condition is false.

Parameters

mixed $condition
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileEquals() public static

assertFileEquals(string $expected, string $actual, string $message, bool $canonicalize, bool $ignoreCase)

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

Parameters

string $expected
string $actual
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileEqualsCanonicalizing() public static

assertFileEqualsCanonicalizing(string $expected, string $actual, string $message)

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

Parameters

string $expected
string $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileEqualsIgnoringCase() public static

assertFileEqualsIgnoringCase(string $expected, string $actual, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileExists() public static

assertFileExists(string $filename, string $message)

Asserts that a file exists.

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileIsReadable() public static

assertFileIsReadable(string $file, string $message)

Asserts that a file exists and is readable.

Parameters

string $file
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileIsWritable() public static

assertFileIsWritable(string $file, string $message)

Asserts that a file exists and is writable.

Parameters

string $file
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotEquals() public static

assertFileNotEquals(string $expected, string $actual, string $message, bool $canonicalize, bool $ignoreCase)

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

Parameters

string $expected
string $actual
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotEqualsCanonicalizing() public static

assertFileNotEqualsCanonicalizing(string $expected, string $actual, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotEqualsIgnoringCase() public static

assertFileNotEqualsIgnoringCase(string $expected, string $actual, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotExists() public static

assertFileNotExists(string $filename, string $message)

Asserts that a file does not exist.

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotIsReadable() public static

assertFileNotIsReadable(string $file, string $message)

Asserts that a file exists and is not readable.

Parameters

string $file
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileNotIsWritable() public static

assertFileNotIsWritable(string $file, string $message)

Asserts that a file exists and is not writable.

Parameters

string $file
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFileResponse() public

assertFileResponse(string $expected, string $message)

Asserts that a file with the given name was sent in the response

Parameters

string $expected

The absolute file path that should be sent in the response.

string $message optional

The failure message that will be appended to the generated message.

assertFinite() public static

assertFinite(mixed $actual, string $message)

Asserts that a variable is finite.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertFlashElement() public

assertFlashElement(string $expected, string $key, string $message)

Asserts a flash element was set

Parameters

string $expected

Expected element name

string $key optional

Flash key

string $message optional

Assertion failure message

assertFlashElementAt() public

assertFlashElementAt(int $at, string $expected, string $key, string $message)

Asserts a flash element was set at a certain index

Parameters

int $at

Flash index

string $expected

Expected element name

string $key optional

Flash key

string $message optional

Assertion failure message

assertFlashMessage() public

assertFlashMessage(string $expected, string $key, string $message)

Asserts a flash message was set

Parameters

string $expected

Expected message

string $key optional

Flash key

string $message optional

Assertion failure message

assertFlashMessageAt() public

assertFlashMessageAt(int $at, string $expected, string $key, string $message)

Asserts a flash message was set at a certain index

Parameters

int $at

Flash index

string $expected

Expected message

string $key optional

Flash key

string $message optional

Assertion failure message

assertGreaterThan() public static

assertGreaterThan(mixed $expected, mixed $actual, string $message)

Asserts that a value is greater than another value.

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertGreaterThanOrEqual() public static

assertGreaterThanOrEqual(mixed $expected, mixed $actual, string $message)

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

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertHeader() public

assertHeader(string $header, string $content, string $message)

Asserts response headers

Parameters

string $header

The header to check

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertHeaderContains() public

assertHeaderContains(string $header, string $content, string $message)

Asserts response header contains a string

Parameters

string $header

The header to check

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertHeaderNotContains() public

assertHeaderNotContains(string $header, string $content, string $message)

Asserts response header does not contain a string

Parameters

string $header

The header to check

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertHtml() public

assertHtml(array $expected, string $string, bool $fullDebug)

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 or not more verbose output should be used.

Returns

bool

assertInfinite() public static

assertInfinite(mixed $actual, string $message)

Asserts that a variable is infinite.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertInstanceOf() public static

assertInstanceOf(string $expected, mixed $actual, string $message)

Asserts that a variable is of a given type.

Parameters

string $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertInternalType() public static

assertInternalType(string $expected, mixed $actual, string $message)

Asserts that a variable is of a given type.

Parameters

string $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsArray() public static

assertIsArray(mixed $actual, string $message)

Asserts that a variable is of type array.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsBool() public static

assertIsBool(mixed $actual, string $message)

Asserts that a variable is of type bool.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsCallable() public static

assertIsCallable(mixed $actual, string $message)

Asserts that a variable is of type callable.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsFloat() public static

assertIsFloat(mixed $actual, string $message)

Asserts that a variable is of type float.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsInt() public static

assertIsInt(mixed $actual, string $message)

Asserts that a variable is of type int.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsIterable() public static

assertIsIterable(mixed $actual, string $message)

Asserts that a variable is of type iterable.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotArray() public static

assertIsNotArray(mixed $actual, string $message)

Asserts that a variable is not of type array.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotBool() public static

assertIsNotBool(mixed $actual, string $message)

Asserts that a variable is not of type bool.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotCallable() public static

assertIsNotCallable(mixed $actual, string $message)

Asserts that a variable is not of type callable.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotFloat() public static

assertIsNotFloat(mixed $actual, string $message)

Asserts that a variable is not of type float.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotInt() public static

assertIsNotInt(mixed $actual, string $message)

Asserts that a variable is not of type int.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotIterable() public static

assertIsNotIterable(mixed $actual, string $message)

Asserts that a variable is not of type iterable.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotNumeric() public static

assertIsNotNumeric(mixed $actual, string $message)

Asserts that a variable is not of type numeric.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotObject() public static

assertIsNotObject(mixed $actual, string $message)

Asserts that a variable is not of type object.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotResource() public static

assertIsNotResource(mixed $actual, string $message)

Asserts that a variable is not of type resource.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotScalar() public static

assertIsNotScalar(mixed $actual, string $message)

Asserts that a variable is not of type scalar.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNotString() public static

assertIsNotString(mixed $actual, string $message)

Asserts that a variable is not of type string.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsNumeric() public static

assertIsNumeric(mixed $actual, string $message)

Asserts that a variable is of type numeric.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsObject() public static

assertIsObject(mixed $actual, string $message)

Asserts that a variable is of type object.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsReadable() public static

assertIsReadable(string $filename, string $message)

Asserts that a file/dir is readable.

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsResource() public static

assertIsResource(mixed $actual, string $message)

Asserts that a variable is of type resource.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsScalar() public static

assertIsScalar(mixed $actual, string $message)

Asserts that a variable is of type scalar.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsString() public static

assertIsString(mixed $actual, string $message)

Asserts that a variable is of type string.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertIsWritable() public static

assertIsWritable(string $filename, string $message)

Asserts that a file/dir exists and is writable.

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJson() public static

assertJson(string $actualJson, string $message)

Asserts that a string is a valid JSON string.

Parameters

string $actualJson
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonFileEqualsJsonFile() public static

assertJsonFileEqualsJsonFile(string $expectedFile, string $actualFile, string $message)

Asserts that two JSON files are equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonFileNotEqualsJsonFile() public static

assertJsonFileNotEqualsJsonFile(string $expectedFile, string $actualFile, string $message)

Asserts that two JSON files are not equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonStringEqualsJsonFile() public static

assertJsonStringEqualsJsonFile(string $expectedFile, string $actualJson, string $message)

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

Parameters

string $expectedFile
string $actualJson
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonStringEqualsJsonString() public static

assertJsonStringEqualsJsonString(string $expectedJson, string $actualJson, string $message)

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

Parameters

string $expectedJson
string $actualJson
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonStringNotEqualsJsonFile() public static

assertJsonStringNotEqualsJsonFile(string $expectedFile, string $actualJson, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertJsonStringNotEqualsJsonString() public static

assertJsonStringNotEqualsJsonString(mixed $expectedJson, mixed $actualJson, string $message)

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

Parameters

string $expectedJson
string $actualJson
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertLayout() public

assertLayout(string $content, string $message)

Asserts that the search string was in the layout name.

Parameters

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertLessThan() public static

assertLessThan(mixed $expected, mixed $actual, string $message)

Asserts that a value is smaller than another value.

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertLessThanOrEqual() public static

assertLessThanOrEqual(mixed $expected, mixed $actual, string $message)

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

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNan() public static

assertNan(mixed $actual, string $message)

Asserts that a variable is nan.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNoRedirect() public

assertNoRedirect(string $message)

Asserts that the Location header is not set.

Parameters

string $message optional

The failure message that will be appended to the generated message.

assertNotContains() public static

assertNotContains(mixed $needle, mixed $haystack, string $message, bool $ignoreCase, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)

Asserts that a haystack does not contain a needle.

Parameters

mixed $needle
mixed $haystack
string $message optional
bool $ignoreCase optional
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertNotContainsEquals() public static

assertNotContainsEquals(mixed $needle, iterable $haystack, string $message)

Parameters

mixed $needle
iterable $haystack
string $message optional

assertNotContainsOnly() public static

assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType, string $message)

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

Parameters

string $type
iterable $haystack
?bool $isNativeType optional
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotCount() public static

assertNotCount(int $expectedCount, mixed $haystack, string $message)

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

Parameters

int $expectedCount
\Countable|iterable $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertNotEmpty() public static

assertNotEmpty(mixed $actual, string $message)

Asserts that a variable is not empty.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotEquals() public static

assertNotEquals(mixed $expected, mixed $actual, string $message, mixed $delta, mixed $maxDepth, mixed $canonicalize, mixed $ignoreCase)

Asserts that two variables are not equal.

Parameters

mixed $expected
mixed $actual
string $message optional
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotEqualsCanonicalizing() public static

assertNotEqualsCanonicalizing(mixed $expected, mixed $actual, string $message)

Asserts that two variables are not equal (canonicalizing).

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotEqualsIgnoringCase() public static

assertNotEqualsIgnoringCase(mixed $expected, mixed $actual, string $message)

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

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotEqualsWithDelta() public static

assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message)

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

Parameters

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotFalse() public static

assertNotFalse(mixed $condition, string $message)

Asserts that a condition is not false.

Parameters

mixed $condition
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotInstanceOf() public static

assertNotInstanceOf(string $expected, mixed $actual, string $message)

Asserts that a variable is not of a given type.

Parameters

string $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertNotInternalType() public static

assertNotInternalType(string $expected, mixed $actual, string $message)

Asserts that a variable is not of a given type.

Parameters

string $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotIsReadable() public static

assertNotIsReadable(string $filename, string $message)

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

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotIsWritable() public static

assertNotIsWritable(string $filename, string $message)

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

Parameters

string $filename
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotNull() public static

assertNotNull(mixed $actual, string $message)

Asserts that a variable is not null.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotRegExp() public static

assertNotRegExp(string $pattern, string $string, string $message)

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

Parameters

string $pattern
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotSame() public static

assertNotSame(mixed $expected, mixed $actual, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotSameSize() public static

assertNotSameSize(mixed $expected, mixed $actual, string $message)

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

Parameters

\Countable|iterable $expected
\Countable|iterable $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertNotTrue() public static

assertNotTrue(mixed $condition, string $message)

Asserts that a condition is not true.

Parameters

mixed $condition
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertNotWithinRange() protected static

assertNotWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)

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

assertNull() public static

assertNull(mixed $actual, string $message)

Asserts that a variable is null.

Parameters

mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertObjectHasAttribute() public static

assertObjectHasAttribute(string $attributeName, mixed $object, string $message)

Asserts that an object has a specified attribute.

Parameters

string $attributeName
object $object
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertObjectNotHasAttribute() public static

assertObjectNotHasAttribute(string $attributeName, mixed $object, string $message)

Asserts that an object does not have a specified attribute.

Parameters

string $attributeName
object $object
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertPathEquals() protected static

assertPathEquals(mixed $expected, mixed $result, mixed $message)

Compatibility function to test paths.

Parameters

string $expected
string $result
string $message optional

the text to display if the assertion is not correct

assertPostConditions() protected

assertPostConditions()

Performs assertions shared by all tests of a test case.

This method is called between test and tearDown().

assertPreConditions() protected

assertPreConditions()

Performs assertions shared by all tests of a test case.

This method is called between setUp() and test.

assertRedirect() public

assertRedirect(mixed $url, mixed $message)

Asserts that the Location header is correct. Comparison is made against a full URL.

Parameters

string|array|null $url optional

The URL you expected the client to go to. This can either be a string URL or an array compatible with Router::url(). Use null to simply check for the existence of this header.

string $message optional

The failure message that will be appended to the generated message.

assertRedirectContains() public

assertRedirectContains(string $url, string $message)

Asserts that the Location header contains a substring

Parameters

string $url

The URL you expected the client to go to.

string $message optional

The failure message that will be appended to the generated message.

assertRedirectEquals() public

assertRedirectEquals(mixed $url, mixed $message)

Asserts that the Location header is correct. Comparison is made against exactly the URL provided.

Parameters

string|array|null $url optional

The URL you expected the client to go to. This can either be a string URL or an array compatible with Router::url(). Use null to simply check for the existence of this header.

string $message optional

The failure message that will be appended to the generated message.

assertRedirectNotContains() public

assertRedirectNotContains(string $url, string $message)

Asserts that the Location header does not contain a substring

Parameters

string $url

The URL you expected the client to go to.

string $message optional

The failure message that will be appended to the generated message.

assertRegExp() public static

assertRegExp(string $pattern, string $string, string $message)

Asserts that a string matches a given regular expression.

Parameters

string $pattern
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertRegExpSql() public

assertRegExpSql(string $pattern, string $actual, bool $optional)

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

assertResponseCode() public

assertResponseCode(int $code, string $message)

Asserts a specific response status code.

Parameters

int $code

Status code to assert.

string $message optional

Custom message for failure.

assertResponseContains() public

assertResponseContains(string $content, string $message, bool $ignoreCase)

Asserts content exists in the response body.

Parameters

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

bool $ignoreCase optional

A flag to check whether we should ignore case or not.

assertResponseEmpty() public

assertResponseEmpty(string $message)

Assert response content is empty.

Parameters

string $message optional

The failure message that will be appended to the generated message.

assertResponseEquals() public

assertResponseEquals(mixed $content, mixed $message)

Asserts content in the response body equals.

Parameters

mixed $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertResponseError() public

assertResponseError(string $message)

Asserts that the response status code is in the 4xx range.

Parameters

string $message optional

Custom message for failure.

assertResponseFailure() public

assertResponseFailure(string $message)

Asserts that the response status code is in the 5xx range.

Parameters

string $message optional

Custom message for failure.

assertResponseNotContains() public

assertResponseNotContains(string $content, string $message, bool $ignoreCase)

Asserts content does not exist in the response body.

Parameters

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

bool $ignoreCase optional

A flag to check whether we should ignore case or not.

assertResponseNotEmpty() public

assertResponseNotEmpty(string $message)

Assert response content is not empty.

Parameters

string $message optional

The failure message that will be appended to the generated message.

assertResponseNotEquals() public

assertResponseNotEquals(mixed $content, mixed $message)

Asserts content in the response body not equals.

Parameters

mixed $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertResponseNotRegExp() public

assertResponseNotRegExp(string $pattern, string $message)

Asserts that the response body does not match a given regular expression.

Parameters

string $pattern

The pattern to compare against.

string $message optional

The failure message that will be appended to the generated message.

assertResponseOk() public

assertResponseOk(string $message)

Asserts that the response status code is in the 2xx range.

Parameters

string $message optional

Custom message for failure.

assertResponseRegExp() public

assertResponseRegExp(string $pattern, string $message)

Asserts that the response body matches a given regular expression.

Parameters

string $pattern

The pattern to compare against.

string $message optional

The failure message that will be appended to the generated message.

assertResponseSuccess() public

assertResponseSuccess(string $message)

Asserts that the response status code is in the 2xx/3xx range.

Parameters

string $message optional

Custom message for failure.

assertSame() public static

assertSame(mixed $expected, mixed $actual, string $message)

Asserts that two variables have the same type and value.

Used on objects, it asserts that two variables reference the same object.

Parameters

mixed $expected
mixed $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertSameSize() public static

assertSameSize(mixed $expected, mixed $actual, string $message)

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

Parameters

\Countable|iterable $expected
\Countable|iterable $actual
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertSession() public

assertSession(mixed $expected, string $path, string $message)

Asserts session contents

Parameters

mixed $expected

The expected contents.

string $path

The session data path. Uses Hash::get() compatible notation

string $message optional

The failure message that will be appended to the generated message.

assertSessionHasKey() public

assertSessionHasKey(string $path, string $message)

Asserts session key exists.

Parameters

string $path

The session data path. Uses Hash::get() compatible notation.

string $message optional

The failure message that will be appended to the generated message.

assertSessionNotHasKey() public

assertSessionNotHasKey(string $path, string $message)

Asserts a session key does not exist.

Parameters

string $path

The session data path. Uses Hash::get() compatible notation.

string $message optional

The failure message that will be appended to the generated message.

assertStringContainsString() public static

assertStringContainsString(string $needle, string $haystack, string $message)

Parameters

string $needle
string $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringContainsStringIgnoringCase() public static

assertStringContainsStringIgnoringCase(string $needle, string $haystack, string $message)

Parameters

string $needle
string $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringEndsNotWith() public static

assertStringEndsNotWith(string $suffix, string $string, string $message)

Asserts that a string ends not with a given suffix.

Parameters

string $suffix
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringEndsWith() public static

assertStringEndsWith(string $suffix, string $string, string $message)

Asserts that a string ends with a given suffix.

Parameters

string $suffix
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringEqualsFile() public static

assertStringEqualsFile(string $expectedFile, string $actualString, string $message, bool $canonicalize, bool $ignoreCase)

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

Parameters

string $expectedFile
string $actualString
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringEqualsFileCanonicalizing() public static

assertStringEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message)

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

Parameters

string $expectedFile
string $actualString
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringEqualsFileIgnoringCase() public static

assertStringEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringMatchesFormat() public static

assertStringMatchesFormat(string $format, string $string, string $message)

Asserts that a string matches a given format string.

Parameters

string $format
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringMatchesFormatFile() public static

assertStringMatchesFormatFile(string $formatFile, string $string, string $message)

Asserts that a string matches a given format file.

Parameters

string $formatFile
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotContainsString() public static

assertStringNotContainsString(string $needle, string $haystack, string $message)

Parameters

string $needle
string $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotContainsStringIgnoringCase() public static

assertStringNotContainsStringIgnoringCase(string $needle, string $haystack, string $message)

Parameters

string $needle
string $haystack
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotEqualsFile() public static

assertStringNotEqualsFile(string $expectedFile, string $actualString, string $message, bool $canonicalize, bool $ignoreCase)

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

Parameters

string $expectedFile
string $actualString
string $message optional
bool $canonicalize optional
bool $ignoreCase optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotEqualsFileCanonicalizing() public static

assertStringNotEqualsFileCanonicalizing(string $expectedFile, string $actualString, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotEqualsFileIgnoringCase() public static

assertStringNotEqualsFileIgnoringCase(string $expectedFile, string $actualString, string $message)

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

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotMatchesFormat() public static

assertStringNotMatchesFormat(string $format, string $string, string $message)

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

Parameters

string $format
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringNotMatchesFormatFile() public static

assertStringNotMatchesFormatFile(string $formatFile, string $string, string $message)

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

Parameters

string $formatFile
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringStartsNotWith() public static

assertStringStartsNotWith(mixed $prefix, mixed $string, string $message)

Asserts that a string starts not with a given prefix.

Parameters

string $prefix
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertStringStartsWith() public static

assertStringStartsWith(string $prefix, string $string, string $message)

Asserts that a string starts with a given prefix.

Parameters

string $prefix
string $string
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertTemplate() public

assertTemplate(string $content, string $message)

Asserts that the search string was in the template name.

Parameters

string $content

The content to check for.

string $message optional

The failure message that will be appended to the generated message.

assertTextContains() public

assertTextContains(string $needle, string $haystack, string $message, bool $ignoreCase)

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 or not the search should be case-sensitive.

assertTextEndsNotWith() public

assertTextEndsNotWith(string $suffix, string $string, string $message)

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.

assertTextEndsWith() public

assertTextEndsWith(string $suffix, string $string, string $message)

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.

assertTextEquals() public

assertTextEquals(string $expected, string $result, string $message)

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.

assertTextNotContains() public

assertTextNotContains(string $needle, string $haystack, string $message, bool $ignoreCase)

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 or not the search should be case-sensitive.

assertTextNotEquals() public

assertTextNotEquals(string $expected, string $result, string $message)

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.

assertTextStartsNotWith() public

assertTextStartsNotWith(string $prefix, string $string, string $message)

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.

assertTextStartsWith() public

assertTextStartsWith(string $prefix, string $string, string $message)

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.

assertThat() public static

assertThat(mixed $value, \PHPUnit\Framework\Constraint\Constraint $constraint, string $message)

Evaluates a PHPUnit\Framework\Constraint matcher object.

Parameters

mixed $value
\PHPUnit\Framework\Constraint\Constraint $constraint
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertTrue() public static

assertTrue(mixed $condition, string $message)

Asserts that a condition is true.

Parameters

mixed $condition
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

assertWithinRange() protected static

assertWithinRange(mixed $expected, mixed $result, mixed $margin, mixed $message)

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

assertXmlFileEqualsXmlFile() public static

assertXmlFileEqualsXmlFile(string $expectedFile, string $actualFile, string $message)

Asserts that two XML files are equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertXmlFileNotEqualsXmlFile() public static

assertXmlFileNotEqualsXmlFile(string $expectedFile, string $actualFile, string $message)

Asserts that two XML files are not equal.

Parameters

string $expectedFile
string $actualFile
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertXmlStringEqualsXmlFile() public static

assertXmlStringEqualsXmlFile(string $expectedFile, mixed $actualXml, string $message)

Asserts that two XML documents are equal.

Parameters

string $expectedFile
\DOMDocument|string $actualXml
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertXmlStringEqualsXmlString() public static

assertXmlStringEqualsXmlString(mixed $expectedXml, mixed $actualXml, string $message)

Asserts that two XML documents are equal.

Parameters

\DOMDocument|string $expectedXml
\DOMDocument|string $actualXml
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertXmlStringNotEqualsXmlFile() public static

assertXmlStringNotEqualsXmlFile(string $expectedFile, mixed $actualXml, string $message)

Asserts that two XML documents are not equal.

Parameters

string $expectedFile
\DOMDocument|string $actualXml
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

assertXmlStringNotEqualsXmlString() public static

assertXmlStringNotEqualsXmlString(mixed $expectedXml, mixed $actualXml, string $message)

Asserts that two XML documents are not equal.

Parameters

\DOMDocument|string $expectedXml
\DOMDocument|string $actualXml
string $message optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

at() public static

at(int $index)

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

Parameters

int $index

atLeast() public static

atLeast(int $requiredInvocations)

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

Parameters

int $requiredInvocations

atLeastOnce() public static

atLeastOnce()

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

atMost() public static

atMost(int $allowedInvocations)

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

Parameters

int $allowedInvocations

attribute() public static

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

Parameters

\PHPUnit\Framework\Constraint\Constraint $constraint
string $attributeName

attributeEqualTo() public static

attributeEqualTo(string $attributeName, mixed $value, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)

Parameters

string $attributeName
mixed $value
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

callback() public static

callback(callable $callback)

Parameters

callable $callback

classHasAttribute() public static

classHasAttribute(string $attributeName)

Parameters

string $attributeName

classHasStaticAttribute() public static

classHasStaticAttribute(string $attributeName)

Parameters

string $attributeName

cleanup() public

cleanup()

Clears the state used for requests.

clearPlugins() public

clearPlugins()

Clear all plugins from the global plugin collection.

Useful in test case teardown methods.

configApplication() public

configApplication(string $class, ?array $constructorArgs)

Configure the application class to use in integration tests.

Parameters

string $class

The application class name.

array|null $constructorArgs

The constructor arguments for your application class.

configRequest() public

configRequest(array $data)

Configures the data for the next request.

This data is cleared in the tearDown() method.

You can call this method multiple times to append into the current state.

Parameters

array $data

The request data to use.

contains() public static

contains(mixed $value, bool $checkForObjectIdentity, bool $checkForNonObjectIdentity)

Parameters

mixed $value
bool $checkForObjectIdentity optional
bool $checkForNonObjectIdentity optional

containsEqual() public static

containsEqual(mixed $value)

Parameters

mixed $value

containsIdentical() public static

containsIdentical(mixed $value)

Parameters

mixed $value

containsOnly() public static

containsOnly(string $type)

Parameters

string $type

containsOnlyInstancesOf() public static

containsOnlyInstancesOf(string $className)

Parameters

string $className

controllerSpy() public

controllerSpy(\Cake\Event\EventInterface $event, ?\Cake\Controller\Controller $controller)

Adds additional event spies to the controller/view event manager.

Parameters

\Cake\Event\EventInterface $event

A dispatcher event.

\Cake\Controller\Controller|null $controller optional

Controller instance.

cookie(string $name, mixed $value)

Sets a request cookie for future requests.

This method lets you configure the session data you want to be used for requests that follow. The session state is reset in each tearDown().

You can call this method multiple times to append into the current state.

Parameters

string $name

The cookie name to use.

mixed $value

The value of the cookie.

cookieEncrypted() public

cookieEncrypted(string $name, mixed $value, mixed $encrypt, mixed $key)

Sets a encrypted request cookie for future requests.

The difference from cookie() is this encrypts the cookie value like the CookieComponent.

Parameters

string $name

The cookie name to use.

mixed $value

The value of the cookie.

string|false $encrypt optional

Encryption mode to use.

string|null $key optional

Encryption key used. Defaults to Security.salt.

See Also

\Cake\Utility\CookieCryptTrait::_encrypt()

count() public

count()

countOf() public static

countOf(int $count)

Parameters

int $count

createConfiguredMock() protected

createConfiguredMock(mixed $originalClassName, array $configuration)

Returns a configured mock object for the specified class.

Parameters

string|string[] $originalClassName
array $configuration

createMock() protected

createMock(mixed $originalClassName)

Returns a mock object for the specified class.

Parameters

string|string[] $originalClassName

createPartialMock() protected

createPartialMock(mixed $originalClassName, array $methods)

Returns a partial mock object for the specified class.

Parameters

string|string[] $originalClassName
string[] $methods

createResult() protected

createResult()

Creates a default TestResult object.

createStub() protected

createStub(string $originalClassName)

Makes configurable stub for the specified class.

Parameters

string $originalClassName

createTestProxy() protected

createTestProxy(string $originalClassName, array $constructorArguments)

Returns a test proxy for the specified class.

Parameters

string $originalClassName
array $constructorArguments optional

dataDescription() public

dataDescription()

dataName() public

dataName()

Returns

int|string

delete() public

delete(mixed $url)

Performs a DELETE request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

deprecated() public

deprecated(callable $callable)

Helper method for check deprecation methods

Parameters

callable $callable

callable function that will receive asserts

directoryExists() public static

directoryExists()

disableErrorHandlerMiddleware() public

disableErrorHandlerMiddleware()

Disable the error handler middleware.

By using this function, exceptions are no longer caught by the ErrorHandlerMiddleware and are instead re-thrown by the TestExceptionRenderer. This can be helpful when trying to diagnose/debug unexpected failures in test cases.

doesNotPerformAssertions() public

doesNotPerformAssertions()

doubledTypes() public

doubledTypes()

Returns

string[]

enableCsrfToken() public

enableCsrfToken()

Calling this method will add a CSRF token to the request.

Both the POST data and cookie will be populated when this option is enabled. The default parameter names will be used.

enableRetainFlashMessages() public

enableRetainFlashMessages()

Calling this method will re-store flash messages into the test session after being removed by the FlashHelper

enableSecurityToken() public

enableSecurityToken()

Calling this method will enable a SecurityComponent compatible token to be added to request data. This lets you easily test actions protected by SecurityComponent.

equalTo() public static

equalTo(mixed $value, float $delta, int $maxDepth, bool $canonicalize, bool $ignoreCase)

Parameters

mixed $value
float $delta optional
int $maxDepth optional
bool $canonicalize optional
bool $ignoreCase optional

exactly() public static

exactly(int $count)

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

Parameters

int $count

expectDeprecation() public

expectDeprecation()

expectDeprecationMessage() public

expectDeprecationMessage(string $message)

Parameters

string $message

expectDeprecationMessageMatches() public

expectDeprecationMessageMatches(string $regularExpression)

Parameters

string $regularExpression

expectError() public

expectError()

expectErrorMessage() public

expectErrorMessage(string $message)

Parameters

string $message

expectErrorMessageMatches() public

expectErrorMessageMatches(string $regularExpression)

Parameters

string $regularExpression

expectException() public

expectException(string $exception)

Parameters

string $exception

expectExceptionCode() public

expectExceptionCode(mixed $code)

Parameters

int|string $code

expectExceptionMessage() public

expectExceptionMessage(string $message)

Parameters

string $message

expectExceptionMessageMatches() public

expectExceptionMessageMatches(string $regularExpression)

Parameters

string $regularExpression

expectExceptionMessageRegExp() public

expectExceptionMessageRegExp(string $regularExpression)

Parameters

string $regularExpression

expectExceptionObject() public

expectExceptionObject(\Exception $exception)

Sets up an expectation for an exception to be raised by the code under test.

Information for expected exception class, expected exception message, and expected exception code are retrieved from a given Exception object.

Parameters

\Exception $exception

expectNotToPerformAssertions() public

expectNotToPerformAssertions()

expectNotice() public

expectNotice()

expectNoticeMessage() public

expectNoticeMessage(string $message)

Parameters

string $message

expectNoticeMessageMatches() public

expectNoticeMessageMatches(string $regularExpression)

Parameters

string $regularExpression

expectOutputRegex() public

expectOutputRegex(string $expectedRegex)

Parameters

string $expectedRegex

expectOutputString() public

expectOutputString(string $expectedString)

Parameters

string $expectedString

expectWarning() public

expectWarning()

expectWarningMessage() public

expectWarningMessage(string $message)

Parameters

string $message

expectWarningMessageMatches() public

expectWarningMessageMatches(string $regularExpression)

Parameters

string $regularExpression

extractExceptionMessage() protected

extractExceptionMessage(\Exception $exception)

Extract verbose message for existing exception

Parameters

\Exception $exception

Exception to extract

Returns

string

extractVerboseMessage() protected

extractVerboseMessage(string $message)

Inspect controller to extract possible causes of the failed assertion

Parameters

string $message

Original message to use as a base

Returns

string

fail() public static

fail(string $message)

Fails a test with the given message.

Parameters

string $message optional

Throws

PHPUnit\Framework\AssertionFailedError

fileExists() public static

fileExists()

get() public

get(mixed $url)

Performs a GET request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

getActualOutput() public

getActualOutput()

getActualOutputForAssertion() public

getActualOutputForAssertion()

getAnnotations() public

getAnnotations()

getCount() public static

getCount()

Return the current assertion count.

getDataSetAsString() public

getDataSetAsString(bool $includeData)

Parameters

bool $includeData optional

getDependencies() public

getDependencies()

getDependencyInput() public

getDependencyInput()

getExpectedException() public

getExpectedException()

getExpectedExceptionCode() public

getExpectedExceptionCode()

Returns

null|int|string

getExpectedExceptionMessage() public

getExpectedExceptionMessage()

getExpectedExceptionMessageRegExp() public

getExpectedExceptionMessageRegExp()

getFixtures() public

getFixtures()

Gets fixtures.

Returns

string[]

getGroups() public

getGroups()

getMockBuilder() public

getMockBuilder(mixed $className)

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

Parameters

string|string[] $className

getMockClass() protected

getMockClass(mixed $originalClassName, mixed $methods, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $cloneArguments)

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

Parameters

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

getMockForAbstractClass() protected

getMockForAbstractClass(mixed $originalClassName, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $mockedMethods, mixed $cloneArguments)

Returns a mock object for the specified abstract class with all abstract methods of the class mocked. Concrete methods are not mocked by default.

To mock concrete methods, use the 7th parameter ($mockedMethods).

Parameters

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

getMockForModel() public

getMockForModel(string $alias, array $methods, array $options)

Mock a model, maintain fixtures and table association

Parameters

string $alias

The model to get a mock for.

string[] $methods optional

The list of methods to mock

array $options optional

The config data for the mock's constructor.

Returns

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

Throws

Cake\ORM\Exception\MissingTableClassException

getMockForTrait() protected

getMockForTrait(mixed $traitName, array $arguments, mixed $mockClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload, mixed $mockedMethods, mixed $cloneArguments)

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

Parameters

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

getMockFromWsdl() protected

getMockFromWsdl(mixed $wsdlFile, mixed $originalClassName, mixed $mockClassName, array $methods, mixed $callOriginalConstructor, array $options)

Returns a mock object based on the given WSDL file.

Parameters

string $wsdlFile
string $originalClassName optional
string $mockClassName optional
array $methods optional
bool $callOriginalConstructor optional
array $options optional

An array of options passed to SOAPClient::_construct

getName() public

getName(bool $withDataSet)

Parameters

bool $withDataSet optional

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

getNumAssertions() public

getNumAssertions()

Returns the number of assertions performed by this test.

getObjectAttribute() public static

getObjectAttribute(mixed $object, string $attributeName)

Returns the value of an object's attribute.

This also works for attributes that are declared protected or private.

Parameters

object $object
string $attributeName

Throws

PHPUnit\Framework\Exception

getObjectForTrait() protected

getObjectForTrait(mixed $traitName, array $arguments, mixed $traitClassName, mixed $callOriginalConstructor, mixed $callOriginalClone, mixed $callAutoload)

Returns an object for the specified trait.

Parameters

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

Returns

object

getProvidedData() public

getProvidedData()

Gets the data set of a TestCase.

getResult() public

getResult()

getSession() protected

getSession()

Returns

\Cake\TestSuite\TestSession

getSize() public

getSize()

Returns the size of the test.

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

getStaticAttribute() public static

getStaticAttribute(string $className, string $attributeName)

Returns the value of a static attribute.

This also works for attributes that are declared protected or private.

Parameters

string $className
string $attributeName

Throws

PHPUnit\Framework\Exception

getStatus() public

getStatus()

getStatusMessage() public

getStatusMessage()

getTableLocator() public

getTableLocator()

Gets the table locator.

Returns

\Cake\ORM\Locator\LocatorInterface

getTestResultObject() public

getTestResultObject()

greaterThan() public static

greaterThan(mixed $value)

Parameters

mixed $value

greaterThanOrEqual() public static

greaterThanOrEqual(mixed $value)

Parameters

mixed $value

hasDependencies() public

hasDependencies()

hasExpectationOnOutput() public

hasExpectationOnOutput()

hasFailed() public

hasFailed()

hasOutput() public

hasOutput()

hasSize() public

hasSize()

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException
head(mixed $url)

Performs a HEAD request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

identicalTo() public static

identicalTo(mixed $value)

Parameters

mixed $value

iniSet() protected

iniSet(string $varName, string $newValue)

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

Parameters

string $varName
string $newValue

Throws

PHPUnit\Framework\Exception

isEmpty() public static

isEmpty()

isFalse() public static

isFalse()

isFinite() public static

isFinite()

isInIsolation() public

isInIsolation()

isInfinite() public static

isInfinite()

isInstanceOf() public static

isInstanceOf(string $className)

Parameters

string $className

isJson() public static

isJson()

isLarge() public

isLarge()

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

isMedium() public

isMedium()

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

isNan() public static

isNan()

isNull() public static

isNull()

isReadable() public static

isReadable()

isSmall() public

isSmall()

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

isTrue() public static

isTrue()

isType() public static

isType(string $type)

Parameters

string $type

isWritable() public static

isWritable()

lessThan() public static

lessThan(mixed $value)

Parameters

mixed $value

lessThanOrEqual() public static

lessThanOrEqual(mixed $value)

Parameters

mixed $value

loadFixtures() public

loadFixtures()

Chooses which fixtures to load for a given test

Each parameter is a model name that corresponds to a fixture, i.e. 'Posts', 'Authors', etc. Passing no parameters will cause all fixtures on the test case to load.

Throws

RuntimeException
when no fixture manager is available.

See Also

\Cake\TestSuite\TestCase::$autoFixtures

loadPlugins() public

loadPlugins(array $plugins)

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 $appArgs)

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.

logicalAnd() public static

logicalAnd()

Throws

PHPUnit\Framework\Exception

logicalNot() public static

logicalNot(\PHPUnit\Framework\Constraint\Constraint $constraint)

Parameters

\PHPUnit\Framework\Constraint\Constraint $constraint

logicalOr() public static

logicalOr()

logicalXor() public static

logicalXor()

markAsRisky() public

markAsRisky()

markTestIncomplete() public static

markTestIncomplete(string $message)

Mark the test as incomplete.

Parameters

string $message optional

Throws

PHPUnit\Framework\IncompleteTestError

markTestSkipped() public static

markTestSkipped(string $message)

Mark the test as skipped.

Parameters

string $message optional

Throws

PHPUnit\Framework\SkippedTestError

PHPUnit\Framework\SyntheticSkippedError

matches() public static

matches(string $string)

Parameters

string $string

matchesRegularExpression() public static

matchesRegularExpression(string $pattern)

Parameters

string $pattern

never() public static

never()

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

objectHasAttribute() public static

objectHasAttribute(mixed $attributeName)

Parameters

mixed $attributeName

onConsecutiveCalls() public static

onConsecutiveCalls(mixed ...$args)

Parameters

mixed ...$args

onNotSuccessfulTest() protected

onNotSuccessfulTest(\Throwable $t)

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

Parameters

\Throwable $t

Throws

Throwable

once() public static

once()

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

options() public

options(mixed $url)

Performs an OPTIONS request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

patch() public

patch(mixed $url, mixed $data)

Performs a PATCH request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

string|array $data optional

The data for the request.

post() public

post(mixed $url, mixed $data)

Performs a POST request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

string|array $data optional

The data for the request.

prophesize() protected

prophesize(mixed $classOrInterface)

Parameters

null|string $classOrInterface optional

Throws

Prophecy\Exception\Doubler\ClassNotFoundException

Prophecy\Exception\Doubler\DoubleException

Prophecy\Exception\Doubler\InterfaceNotFoundException

put() public

put(mixed $url, mixed $data)

Performs a PUT request using the current request data.

The response of the dispatched request will be stored as a property. You can use various assert methods to check the response.

Parameters

string|array $url

The URL to request.

string|array $data optional

The data for the request.

readAttribute() public static

readAttribute(mixed $classOrObject, string $attributeName)

Returns the value of an attribute of a class or an object.

This also works for attributes that are declared protected or private.

Parameters

object|string $classOrObject
string $attributeName

Throws

PHPUnit\Framework\Exception

registerComparator() public

registerComparator(\SebastianBergmann\Comparator\Comparator $comparator)

Parameters

\SebastianBergmann\Comparator\Comparator $comparator

registerMockObject() public

registerMockObject(\PHPUnit\Framework\MockObject\MockObject $mockObject)

Parameters

\PHPUnit\Framework\MockObject\MockObject $mockObject

removePlugins() public

removePlugins(array $names)

Remove plugins from the global plugin collection.

Useful in test case teardown methods.

Parameters

string[] $names optional

A list of plugins you want to remove.

resetCount() public static

resetCount()

Reset the assertion counter.

returnArgument() public static

returnArgument(int $argumentIndex)

Parameters

int $argumentIndex

returnCallback() public static

returnCallback(mixed $callback)

Parameters

mixed $callback

returnSelf() public static

returnSelf()

Returns the current object.

This method is useful when mocking a fluent interface.

returnValue() public static

returnValue(mixed $value)

Parameters

mixed $value

returnValueMap() public static

returnValueMap(array $valueMap)

Parameters

array $valueMap

run() public

run(\PHPUnit\Framework\TestResult $result)

Runs the test case and collects the results in a TestResult object.

If no TestResult object is passed a new one will be created.

Parameters

\PHPUnit\Framework\TestResult $result optional

Throws

PHPUnit\Framework\CodeCoverageException

PHPUnit\Util\Exception

SebastianBergmann\CodeCoverage\CoveredCodeNotExecutedException

SebastianBergmann\CodeCoverage\InvalidArgumentException

SebastianBergmann\CodeCoverage\MissingCoversAnnotationException

SebastianBergmann\CodeCoverage\RuntimeException

SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException

SebastianBergmann\RecursionContext\InvalidArgumentException

runBare() public

runBare()

Throws

Throwable

runTest() protected

runTest()

Override to run the test and assert its state.

Throws

PHPUnit\Framework\AssertionFailedError

PHPUnit\Framework\Exception

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\ObjectEnumerator\InvalidArgumentException

Throwable

session() public

session(array $data)

Sets session data.

This method lets you configure the session data you want to be used for requests that follow. The session state is reset in each tearDown().

You can call this method multiple times to append into the current state.

Parameters

array $data

The session data to use.

setAppNamespace() public static

setAppNamespace(string $appNamespace)

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)

Parameters

?bool $backupGlobals

setBackupStaticAttributes() public

setBackupStaticAttributes(?bool $backupStaticAttributes)

Parameters

?bool $backupStaticAttributes

setBeStrictAboutChangesToGlobalState() public

setBeStrictAboutChangesToGlobalState(?bool $beStrictAboutChangesToGlobalState)

Parameters

?bool $beStrictAboutChangesToGlobalState

setDependencies() public

setDependencies(array $dependencies)

Parameters

string[] $dependencies

setDependencyInput() public

setDependencyInput(array $dependencyInput)

Parameters

array $dependencyInput

setGroups() public

setGroups(array $groups)

Parameters

array $groups

setInIsolation() public

setInIsolation(bool $inIsolation)

Parameters

bool $inIsolation

setLocale() protected

setLocale(mixed ...$args)

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

Parameters

mixed ...$args

Throws

PHPUnit\Framework\Exception

setName() public

setName(string $name)

Parameters

string $name

setOutputCallback() public

setOutputCallback(callable $callback)

Parameters

callable $callback

setPreserveGlobalState() public

setPreserveGlobalState(bool $preserveGlobalState)

Parameters

bool $preserveGlobalState

setRegisterMockObjectsFromTestArgumentsRecursively() public

setRegisterMockObjectsFromTestArgumentsRecursively(bool $flag)

Parameters

bool $flag

setResult() public

setResult(mixed $result)

Parameters

mixed $result

setRunClassInSeparateProcess() public

setRunClassInSeparateProcess(bool $runClassInSeparateProcess)

Parameters

bool $runClassInSeparateProcess

setRunTestInSeparateProcess() public

setRunTestInSeparateProcess(bool $runTestInSeparateProcess)

Parameters

bool $runTestInSeparateProcess

setTableLocator() public

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

Sets the table locator.

Parameters

\Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

$this

setTestResultObject() public

setTestResultObject(\PHPUnit\Framework\TestResult $result)

Parameters

\PHPUnit\Framework\TestResult $result

setUnlockedFields() public

setUnlockedFields(array $unlockedFields)

Set list of fields that are excluded from field validation.

Parameters

string[] $unlockedFields optional

List of fields that are excluded from field validation.

setUp() public

setUp()

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

setUpBeforeClass()

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

setUseErrorHandler() public

setUseErrorHandler(bool $useErrorHandler)

Parameters

bool $useErrorHandler

skipIf() public

skipIf(bool $shouldSkip, string $message)

Overrides SimpleTestCase::skipIf to provide a boolean return value

Parameters

bool $shouldSkip

Whether or not the test should be skipped.

string $message optional

The message to display.

Returns

bool

skipUnless() protected

skipUnless(mixed $condition, mixed $message)

Compatibility function for skipping.

Parameters

bool $condition

Condition to trigger skipping

string $message optional

Message for skip

Returns

bool

stringContains() public static

stringContains(string $string, bool $case)

Parameters

string $string
bool $case optional

stringEndsWith() public static

stringEndsWith(string $suffix)

Parameters

string $suffix

stringStartsWith() public static

stringStartsWith(mixed $prefix)

Parameters

mixed $prefix

tearDown() public

tearDown()

teardown any static object changes and restore them.

tearDownAfterClass() public static

tearDownAfterClass()

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

throwException() public static

throwException(\Throwable $exception)

Parameters

\Throwable $exception

toString() public

toString()

Returns a string representation of the test case.

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

PHPUnit\Framework\Exception

useHttpServer() public

useHttpServer(bool $enable)

No-op method.

Parameters

bool $enable

Unused.

usesDataProvider() public

usesDataProvider()

viewVariable() public

viewVariable(string $name)

Fetches a view variable by name.

If the view variable does not exist, null will be returned.

Parameters

string $name

The view variable to get.

Returns

mixed

The view variable if set.

withErrorReporting() public

withErrorReporting(int $errorLevel, callable $callable)

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

Property Detail

$_appArgs protected

The customized application constructor arguments.

Type

array|null

$_appClass protected

The customized application class name.

Type

string|null

$_configure protected

Configure values to restore at end of test.

Type

array

$_controller protected

The controller used in the last request.

Type

\Cake\Controller\Controller

Cookie data to use in the next request.

Type

array

$_cookieEncryptionKey protected

Type

string|null

$_csrfToken protected

Boolean flag for whether or not the request should have a CSRF token added.

Type

bool

$_exception protected

The exception being thrown if the case.

Type

\Throwable|null

$_flashMessages protected

Stored flash messages before render

Type

array|null

$_layoutName protected

The last rendered layout

Type

string

$_request protected

The data used to build the next request.

Type

array

$_requestSession protected

The session instance from the last request

Type

\Cake\Http\Session

$_response protected

The response for the most recent request.

Type

\Psr\Http\Message\ResponseInterface

$_retainFlashMessages protected

Boolean flag for whether or not the request should re-store flash messages

Type

bool

$_securityToken protected

Boolean flag for whether or not the request should have a SecurityComponent token added.

Type

bool

$_session protected

Session data to use in the next request.

Type

array

$_tableLocator protected

Table locator instance

Type

\Cake\ORM\Locator\LocatorInterface|null

$_unlockedFields protected

List of fields that are excluded from field validation.

Type

string[]

$_validCiphers protected

Valid cipher names for encrypted cookies.

Type

string[]

$_viewName protected

The last rendered view

Type

string

$autoFixtures public

By default, all fixtures attached to this class will be truncated and reloaded after each test.

Set this to false to handle manually

Type

bool

$backupGlobals protected

Type

?bool

$backupGlobalsBlacklist protected

Type

string[]

$backupStaticAttributes protected

Type

bool

$backupStaticAttributesBlacklist protected

Type

array<string,array<int,string>>

$dropTables public

Control table create/drops on each test method.

If true, tables will still be dropped at the end of each test runner execution.

Type

bool

$fixtureManager public

The class responsible for managing the creation, loading and removing of fixtures

Type

\Cake\TestSuite\Fixture\FixtureManager|null

$fixtures protected

Fixtures used by this test case.

Type

string[]

$preserveGlobalState protected

Type

bool

$runTestInSeparateProcess protected

Type

bool

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.TestSuite.IntegrationTestCase.html