_addTokens()source 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

_assertStatus()source protected

_assertStatus( integer $min , integer $max , string $message )

Helper method for status assertions.

Parameters

integer $min

Min status code.

integer $max

Max status code.

string $message

The error message.

_buildRequest()source protected

_buildRequest( string|array $url , string $method , array|null $data )

Creates a request object with the configured options and parameters.

Parameters

string|array $url

The URL

string $method

The HTTP method

array|null $data

The request data.

Returns

_getBodyAsString()source protected

_getBodyAsString( )

Get the response body as string

Returns

_getCookieEncryptionKey()source protected

_getCookieEncryptionKey( )

Returns the encryption key to be used.

Returns

_handleError()source protected

_handleError( Exception $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

Exception $exception

Exception to handle.

Throws

_makeDispatcher()source protected

_makeDispatcher( )

Get the correct dispatcher instance.

Returns

_sendRequest()source protected

_sendRequest( string|array $url , string $method , array|null $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

array|null $data optional []

The request data.

Throws

_url()source protected

_url( string|array $url )

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

Parameters

string|array $url

The URL

Returns

assertContentType()source 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()source public

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

Asserts cookie values

Parameters

string $expected

The expected contents.

string $name

The cookie name.

string $message optional ''

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

assertCookieEncrypted()source public

assertCookieEncrypted( string $expected , string $name , string|boolean $encrypt 'aes' , string|null $key null , 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

string $expected

The expected contents.

string $name

The cookie name.

string|boolean $encrypt optional 'aes'

Encryption mode to use.

string|null $key optional null

Encryption key used. Defaults to Security.salt.

string $message optional ''

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

See

assertCookieNotSet()source 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.

assertFileResponse()source public

assertFileResponse( string $expected , string $message '' )

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

Parameters

string $expected

The file name that should be sent in the response

string $message optional ''

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

assertHeader()source 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()source 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.

assertLayout()source 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.

assertNoRedirect()source 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.

assertRedirect()source public

assertRedirect( string|array|null $url null , string $message '' )

Asserts that the Location header is correct.

Parameters

string|array|null $url optional null

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()source 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.

assertResponseCode()source public

assertResponseCode( integer $code , string $message null )

Asserts a specific response status code.

Parameters

integer $code

Status code to assert.

string $message optional null

Custom message for failure.

assertResponseContains()source public

assertResponseContains( string $content , string $message '' , boolean $ignoreCase false )

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.

boolean $ignoreCase optional false

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

assertResponseEmpty()source 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()source public

assertResponseEquals( mixed $content , string $message '' )

Asserts content exists in the response body.

Parameters

mixed $content

The content to check for.

string $message optional ''

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

assertResponseError()source public

assertResponseError( string $message null )

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

Parameters

string $message optional null

Custom message for failure.

assertResponseFailure()source public

assertResponseFailure( string $message null )

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

Parameters

string $message optional null

Custom message for failure.

assertResponseNotContains()source public

assertResponseNotContains( string $content , string $message '' )

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.

assertResponseNotEmpty()source 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.

assertResponseNotRegExp()source 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()source public

assertResponseOk( string $message null )

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

Parameters

string $message optional null

Custom message for failure.

assertResponseRegExp()source 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()source public

assertResponseSuccess( string $message null )

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

Parameters

string $message optional null

Custom message for failure.

assertSession()source public

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

Asserts session contents

Parameters

string $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.

assertTemplate()source 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.

configApplication()source public

configApplication( string $class , array|null $constructorArgs )

Configure the application class to use in integration tests.

Combined with useHttpServer() to customize the class name and constructor arguments of your application class.

Parameters

string $class

The application class name.

array|null $constructorArgs

The constructor arguments for your application class.

configRequest()source 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.

controllerSpy()source public

controllerSpy( Cake\Event\Event $event , Cake\Controller\Controller|null $controller null )

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

Parameters

Cake\Event\Event $event

A dispatcher event.

Cake\Controller\Controller|null $controller optional null

Controller instance.

cookie()source public

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()source public

cookieEncrypted( string $name , mixed $value , string|boolean $encrypt 'aes' , string|null $key null )

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|boolean $encrypt optional 'aes'

Encryption mode to use.

string|null $key optional null

Encryption key used. Defaults to Security.salt.

See

delete()source public

delete( string|array $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.

disableErrorHandlerMiddleware()source 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.

enableCsrfToken()source 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()source public

enableRetainFlashMessages( )

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

enableSecurityToken()source 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.

get()source public

get( string|array $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.

head()source public

head( string|array $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.

options()source public

options( string|array $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()source public

patch( string|array $url , array $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.

array $data optional []

The data for the request.

post()source public

post( string|array $url , array $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.

array $data optional []

The data for the request.

put()source public

put( string|array $url , array $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.

array $data optional []

The data for the request.

session()source 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.

setUp()source public

setUp( )

Auto-detect if the HTTP middleware stack should be used.

Overrides

tearDown()source public

tearDown( )

Clears the state used for requests.

Overrides

useHttpServer()source public

useHttpServer( boolean $enable )

Toggle whether or not you want to use the HTTP Server stack.

Parameters

boolean $enable

Enable/disable the usage of the HTTP Stack.

viewVariable()source 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

_assertAttributes()source protected

_assertAttributes( array $assertions , string $string , boolean $fullDebug false , array|string $regex '' )

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

Parameters

array $assertions

Assertions to run.

string $string

The HTML string to check.

boolean $fullDebug optional false

Whether or not more verbose output should be used.

array|string $regex optional ''

Full regexp from assertHtml

Returns

_getTableClassName()source 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

Throws

_normalizePath()source protected

_normalizePath( string $path )

Normalize a path for comparison.

Parameters

string $path

Path separated by "/" slash.

Returns

assertEventFired()source public

assertEventFired( string $name , Cake\Event\EventManager|null $eventManager null , 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 null

Event manager to check, defaults to global event manager

string $message optional ''

Assertion failure message

assertEventFiredWith()source public

assertEventFiredWith( string $name , string $dataKey , string $dataValue , Cake\Event\EventManager|null $eventManager null , 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

string $dataValue

Data value

Cake\Event\EventManager|null $eventManager optional null

Event manager to check, defaults to global event manager

string $message optional ''

Assertion failure message

assertHtml()source public

assertHtml( array $expected , string $string , boolean $fullDebug false )

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

boolean $fullDebug optional false

Whether or not more verbose output should be used.

Returns

assertNotWithinRange()source protected static

assertNotWithinRange( float $expected , float $result , float $margin , string $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

assertPathEquals()source protected static

assertPathEquals( string $expected , string $result , string $message '' )

Compatibility function to test paths.

Parameters

string $expected

string $result

string $message optional ''

the text to display if the assertion is not correct

assertTags()source public

assertTags( string $string , array $expected , boolean $fullDebug false )

Asserts HTML tags.

Deprecated

Parameters

string $string

An HTML/XHTML/XML string

array $expected

An array, see above

boolean $fullDebug optional false

Whether or not more verbose output should be used.

assertTextContains()source public

assertTextContains( string $needle , string $haystack , string $message '' , boolean $ignoreCase false )

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.

boolean $ignoreCase optional false

Whether or not the search should be case-sensitive.

assertTextEndsNotWith()source 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()source 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()source 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()source public

assertTextNotContains( string $needle , string $haystack , string $message '' , boolean $ignoreCase false )

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.

boolean $ignoreCase optional false

Whether or not the search should be case-sensitive.

assertTextNotEquals()source 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()source 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()source 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.

assertWithinRange()source protected static

assertWithinRange( float $expected , float $result , float $margin , string $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

deprecated()source public

deprecated( callable $callable )

Helper method for check deprecation methods

Parameters

callable $callable

callable function that will receive asserts

getMockForModel()source 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.

array $methods optional []

The list of methods to mock

array $options optional []

The config data for the mock's constructor.

Returns

Throws

loadFixtures()source 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

See

setAppNamespace()source public static

setAppNamespace( string $appNamespace 'TestApp' )

Set the app namespace

Parameters

string $appNamespace optional 'TestApp'

The app namespace, defaults to "TestApp".

skipIf()source public

skipIf( boolean $shouldSkip , string $message '' )

Overrides SimpleTestCase::skipIf to provide a boolean return value

Parameters

boolean $shouldSkip

Whether or not the test should be skipped.

string $message optional ''

The message to display.

Returns

skipUnless()source protected

skipUnless( boolean $condition , string $message '' )

Compatibility function for skipping.

Parameters

boolean $condition

Condition to trigger skipping

string $message optional ''

Message for skip

Returns

withErrorReporting()source public

withErrorReporting( integer $errorLevel , callable $callable )

Helper method for tests that needs to use error_reporting()

Parameters

integer $errorLevel

value of error_reporting() that needs to use

callable $callable

callable function that will receive asserts

_checkCipher()source protected

_checkCipher( string $encrypt )

Helper method for validating encryption cipher names.

Parameters

string $encrypt

The cipher name.

Throws

_decode()source protected

_decode( string $value , string|false $encrypt , string|null $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

_decrypt()source protected

_decrypt( array $values , string|boolean $mode , string|null $key null )

Decrypts $value using public $type method in Security class

Parameters

array $values

Values to decrypt

string|boolean $mode

Encryption mode

string|null $key optional null

Used as the security salt if specified.

Returns

_encrypt()source protected

_encrypt( string $value , string|boolean $encrypt , string|null $key null )

Encrypts $value using public $type method in Security class

Parameters

string $value

Value to encrypt

string|boolean $encrypt

Encryption mode to use. False disabled encryption.

string|null $key optional null

Used as the security salt if specified.

Returns

_explode()source 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

_implode()source protected

_implode( array $array )

Implode method to keep keys are multidimensional arrays

Parameters

array $array

Map of key and values

Returns

_buildFieldToken()source protected

_buildFieldToken( string $url , array $fields , array $unlockedFields [] )

Generate the token data for the provided inputs.

Parameters

string $url

The URL the form is being submitted to.

array $fields

If set specifies the list of fields to use when generating the hash.

array $unlockedFields optional []

The list of fields that are excluded from field validation.

Returns

getTableLocator()source public

getTableLocator( )

Gets the table locator.

Returns

setTableLocator()source public

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

Sets the table locator.

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator

LocatorInterface instance.

Returns

tableLocator()source public

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

Sets the table locator. If no parameters are passed, it will return the currently used locator.

Deprecated

Parameters

Cake\ORM\Locator\LocatorInterface $tableLocator optional null

LocatorInterface instance.

Returns