Fr3nch13/CakePHP Utilities

CoursesControllerTest extends TestCase
in package

Application

uses IntegrationTestTrait

CoursesControllerTest class

Used for testing the Controller Traits within an actual controller.

Properties

$autoFixtures : bool: By default, all fixtures attached to this class will be truncated and reloaded after each test.
$dropTables : bool: Control table create/drops on each test method.
$fixtureManager : FixtureManager|null: The class responsible for managing the creation, loading and removing of fixtures
$_configure : array<string|int, mixed>: Configure values to restore at end of test.
$_controller : Controller|null: The controller used in the last request.
$_cookie : array<string|int, mixed>: Cookie data to use in the next request.
$_cookieEncryptionKey : string|null
$_csrfKeyName : string: The name that will be used when retrieving the csrf token.
$_csrfToken : bool: Boolean flag for whether the request should have a CSRF token added.
$_exception : Throwable|null: The exception being thrown if the case.
$_flashMessages : array<string|int, mixed>: Stored flash messages before render
$_layoutName : string: The last rendered layout
$_request : array<string|int, mixed>: The data used to build the next request.
$_requestSession : Session: The session instance from the last request
$_response : ResponseInterface|null: The response for the most recent request.
$_retainFlashMessages : bool: Boolean flag for whether the request should re-store flash messages
$_securityToken : bool: Boolean flag for whether the request should have a SecurityComponent token added.
$_session : array<string|int, mixed>: Session data to use in the next request.
$_tableLocator : LocatorInterface|null: Table locator instance
$_unlockedFields : array<string|int, string>: List of fields that are excluded from field validation.
$_viewName : string: The last rendered view
$defaultTable : string|null: This object's default table alias.
$fixtures : array<string|int, string>: Fixtures used by this test case.
$fixtureStrategy : FixtureStrategyInterface|null

Methods

assertContentType() : void: Asserts content type
assertCookie() : void: Asserts cookie values
assertCookieEncrypted() : void: Asserts cookie values which are encrypted by the CookieComponent.
assertCookieNotSet() : void: Asserts a cookie has not been set in the response
assertDirectoryDoesNotExist() : void: Asserts that a directory does not exist.
assertDoesNotMatchRegularExpression() : void: Asserts that a string does not match a given regular expression.
assertEqualsSql() : void: Assert that a string matches SQL with db-specific characters like quotes removed.
assertEventFired() : void: Asserts that a global event was fired. You must track events in your event manager for this assertion to work
assertEventFiredWith() : void: Asserts an event was fired with data
assertFileDoesNotExist() : void: Asserts that a file does not exist.
assertFileResponse() : void: Asserts that a file with the given name was sent in the response
assertFlashElement() : void: Asserts a flash element was set
assertFlashElementAt() : void: Asserts a flash element was set at a certain index
assertFlashMessage() : void: Asserts a flash message was set
assertFlashMessageAt() : void: Asserts a flash message was set at a certain index
assertHeader() : void: Asserts response headers
assertHeaderContains() : void: Asserts response header contains a string
assertHeaderNotContains() : void: Asserts response header does not contain a string
assertHtml() : bool: Asserts HTML tags.
assertLayout() : void: Asserts that the search string was in the layout name.
assertMatchesRegularExpression() : void: Asserts that a string matches a given regular expression.
assertNoRedirect() : void: Asserts that the Location header is not set.
assertRedirect() : void: Asserts that the Location header is correct. Comparison is made against a full URL.
assertRedirectContains() : void: Asserts that the Location header contains a substring
assertRedirectEquals() : void: Asserts that the Location header is correct. Comparison is made against exactly the URL provided.
assertRedirectNotContains() : void: Asserts that the Location header does not contain a substring
assertRegExpSql() : void: Assertion for comparing a regex pattern against a query having its identifiers quoted. It accepts queries quoted with the characters `<` and `>`. If the third parameter is set to true, it will alter the pattern to both accept quoted and unquoted queries
assertResponseCode() : void: Asserts a specific response status code.
assertResponseContains() : void: Asserts content exists in the response body.
assertResponseEmpty() : void: Assert response content is empty.
assertResponseEquals() : void: Asserts content in the response body equals.
assertResponseError() : void: Asserts that the response status code is in the 4xx range.
assertResponseFailure() : void: Asserts that the response status code is in the 5xx range.
assertResponseNotContains() : void: Asserts content does not exist in the response body.
assertResponseNotEmpty() : void: Assert response content is not empty.
assertResponseNotEquals() : void: Asserts content in the response body not equals.
assertResponseNotRegExp() : void: Asserts that the response body does not match a given regular expression.
assertResponseOk() : void: Asserts that the response status code is in the 2xx range.
assertResponseRegExp() : void: Asserts that the response body matches a given regular expression.
assertResponseSuccess() : void: Asserts that the response status code is in the 2xx/3xx range.
assertSession() : void: Asserts session contents
assertSessionHasKey() : void: Asserts session key exists.
assertSessionNotHasKey() : void: Asserts a session key does not exist.
assertTemplate() : void: Asserts that the search string was in the template name.
assertTextContains() : void: Assert that a string contains another string, ignoring differences in newlines.
assertTextEndsNotWith() : void: Asserts that a string ends not with a given prefix, ignoring differences in newlines.
assertTextEndsWith() : void: Asserts that a string ends with a given prefix, ignoring differences in newlines.
assertTextEquals() : void: Assert text equality, ignoring differences in newlines.
assertTextNotContains() : void: Assert that a text doesn't contain another text, ignoring differences in newlines.
assertTextNotEquals() : void: Assert text equality, ignoring differences in newlines.
assertTextStartsNotWith() : void: Asserts that a string starts not with a given prefix, ignoring differences in newlines.
assertTextStartsWith() : void: Asserts that a string starts with a given prefix, ignoring differences in newlines.
cleanup() : void: Clears the state used for requests.
clearPlugins() : void: Clear all plugins from the global plugin collection.
configRequest() : void: Configures the data for the *next* request.
controllerSpy() : void: Adds additional event spies to the controller/view event manager.
cookie() : void: Sets a request cookie for future requests.
cookieEncrypted() : void: Sets a encrypted request cookie for future requests.
delete() : void: Performs a DELETE request using the current request data.
deprecated() : void: Helper method for check deprecation methods
disableErrorHandlerMiddleware() : void: Disable the error handler middleware.
enableCsrfToken() : void: Calling this method will add a CSRF token to the request.
enableRetainFlashMessages() : void: Calling this method will re-store flash messages into the test session after being removed by the FlashHelper
enableSecurityToken() : void: Calling this method will enable a SecurityComponent compatible token to be added to request data. This lets you easily test actions protected by SecurityComponent.
fetchTable() : Table: Convenience method to get a table instance.
get() : void: Performs a GET request using the current request data.
getFixtures() : array<string|int, string>: Defines which fixtures we'll be using.
getMockForModel() : Table|MockObject: Mock a model, maintain fixtures and table association
getTableLocator() : LocatorInterface: Gets the table locator.
head() : void: Performs a HEAD request using the current request data.
loadFixtures() : void: Chooses which fixtures to load for a given test
loadPlugins() : BaseApplication: Load plugins into a simulated application.
loadRoutes() : void: Load routes for the application.
options() : void: Performs an OPTIONS request using the current request data.
patch() : void: Performs a PATCH request using the current request data.
post() : void: Performs a POST request using the current request data.
put() : void: Performs a PUT request using the current request data.
removePlugins() : void: Remove plugins from the global plugin collection.
session() : void: Sets session data.
setAppNamespace() : string|null: Set the app namespace
setTableLocator() : $this: Sets the table locator.
setUnlockedFields() : void: Set list of fields that are excluded from field validation.
setUp() : void: setUp method
skipIf() : bool: Overrides SimpleTestCase::skipIf to provide a boolean return value
tearDown() : void: tearDown method
testCoursesIndexGet() : void: test index method
testCoursesMergeDeleteGet() : void: test merge delete method
testCoursesMergeDeleteGetBadModel() : void: test merge delete method
testCoursesMergeDeleteGetDisplayField() : void: test merge delete method
testCoursesMergeDeleteGetMissingId() : void: test merge delete method
testCoursesMergeDeleteGetNoFallback() : void: test merge delete method
testCoursesMergeDeletePost() : void: test merge delete method
testCoursesMergeDeletePostNoId() : void: test merge delete method
testCoursesMergeDeletePostNoTarget() : void: test merge delete method
testCoursesMergeDeletePostReferer() : void: test merge delete method
testCoursesMergeDeleteUnknownID() : void: test merge delete method
testCoursesToggle() : void: test merge delete method
testCoursesToggleBadId() : void: test merge delete method
testCoursesToggleBoolCheck() : void: test merge delete method
testCoursesToggleBoolCheckBadId() : void: test merge delete method
testCoursesToggleBoolCheckDirectJson() : void: test merge delete method
testCoursesToggleBoolCheckJson() : void: test merge delete method
testCoursesToggleBoolCheckReferer() : void: test merge delete method
testCoursesToggleGetBadModel() : void: test merge delete method
testCoursesToggleGetBadModelNoFallback() : void: test merge delete method
testCoursesToggleJson() : void: test merge delete method
testCoursesToggleNoFallback() : void: test merge delete method
viewVariable() : mixed: Fetches a view variable by name.
withErrorReporting() : void: Helper method for tests that needs to use error_reporting()
_addTokens() : array<string|int, mixed>: Add the CSRF and Security Component tokens if necessary.
_assertAttributes() : string|false: Check the attributes as part of an assertTags() check.
_buildRequest() : array<string|int, mixed>: Creates a request object with the configured options and parameters.
_castToString() : array<string|int, mixed>: Recursively casts all data to string as that is how data would be POSTed in the real world
_getBodyAsString() : string: Get the response body as string
_getCookieEncryptionKey() : string: Returns the encryption key to be used.
_getTableClassName() : string: Gets the class name for the table.
_handleError() : void: Attempts to render an error response for a given exception.
_makeDispatcher() : MiddlewareDispatcher: Get the correct dispatcher instance.
_normalizePath() : string: Normalize a path for comparison.
_sendRequest() : void: Creates and send the request into a Dispatcher instance.
_url() : array<string|int, mixed>: Creates a valid request url and parameter array more like Request::_url()
addFixture() : $this: Adds a fixture to this test case.
assertNotWithinRange() : void: Compatibility function to test if a value is not between an acceptable range.
assertPathEquals() : void: Compatibility function to test paths.
assertWithinRange() : void: Compatibility function to test if a value is between an acceptable range.
extractExceptionMessage() : string: Extract verbose message for existing exception
extractVerboseMessage() : string: Inspect controller to extract possible causes of the failed assertion
getFixtureStrategy() : FixtureStrategyInterface: Returns fixture strategy used by these tests.
getSession() : TestSession
setupFixtures() : void: Initialized and loads any use fixtures.
skipUnless() : bool: Compatibility function for skipping.
teardownFixtures() : void: Unloads any use fixtures.

$autoFixtures

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

autoFixtures is only used by deprecated fixture features. This property will be removed in 5.0


    public
        bool
    $autoFixtures
     = true

Set this to false to handle manually

$dropTables

Control table create/drops on each test method.

dropTables is only used by deprecated fixture features. This property will be removed in 5.0


    public
        bool
    $dropTables
     = false

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

$fixtureManager

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


    public
    static    FixtureManager|null
    $fixtureManager

$_configure

Configure values to restore at end of test.


    protected
        array<string|int, mixed>
    $_configure
     = []

$_controller

The controller used in the last request.


    protected
        Controller|null
    $_controller

$_cookie

Cookie data to use in the next request.


    protected
        array<string|int, mixed>
    $_cookie
     = []

$_cookieEncryptionKey


    protected
        string|null
    $_cookieEncryptionKey

$_csrfKeyName

The name that will be used when retrieving the csrf token.


    protected
        string
    $_csrfKeyName
     = 'csrfToken'

$_csrfToken

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


    protected
        bool
    $_csrfToken
     = false

$_exception

The exception being thrown if the case.


    protected
        Throwable|null
    $_exception

$_flashMessages

Stored flash messages before render


    protected
        array<string|int, mixed>
    $_flashMessages
     = []

$_layoutName

The last rendered layout


    protected
        string
    $_layoutName

$_request

The data used to build the next request.


    protected
        array<string|int, mixed>
    $_request
     = []

$_requestSession

The session instance from the last request


    protected
        Session
    $_requestSession

$_response

The response for the most recent request.


    protected
        ResponseInterface|null
    $_response

$_retainFlashMessages

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


    protected
        bool
    $_retainFlashMessages
     = false

$_securityToken

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


    protected
        bool
    $_securityToken
     = false

$_session

Session data to use in the next request.


    protected
        array<string|int, mixed>
    $_session
     = []

$_tableLocator

Table locator instance


    protected
        LocatorInterface|null
    $_tableLocator

$_unlockedFields

List of fields that are excluded from field validation.


    protected
        array<string|int, string>
    $_unlockedFields
     = []

$_viewName

The last rendered view


    protected
        string
    $_viewName

$defaultTable

This object's default table alias.


    protected
        string|null
    $defaultTable
     = null

$fixtures

Fixtures used by this test case.


    protected
        array<string|int, string>
    $fixtures
     = []

$fixtureStrategy


    protected
        FixtureStrategyInterface|null
    $fixtureStrategy
     = null

assertContentType()

Asserts content type


    public
                    assertContentType(string $type[, string $message = '' ]) : void

Parameters

$type : string: The content-type to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertCookie()

Asserts cookie values


    public
                    assertCookie(mixed $expected, string $name[, string $message = '' ]) : void

Parameters

$expected : mixed: The expected contents.
$name : string: The cookie name.
$message : string = '': The failure message that will be appended to the generated message.

assertCookieEncrypted()

Asserts cookie values which are encrypted by the CookieComponent.


    public
                    assertCookieEncrypted(mixed $expected, string $name[, string $encrypt = 'aes' ][, string|null $key = null ][, string $message = '' ]) : void

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

Parameters

$expected : mixed: The expected contents.
$name : string: The cookie name.
$encrypt : string = 'aes': Encryption mode to use.
$key : string|null = null: Encryption key used. Defaults to Security.salt.
$message : string = '': The failure message that will be appended to the generated message.

assertCookieNotSet()

Asserts a cookie has not been set in the response


    public
                    assertCookieNotSet(string $cookie[, string $message = '' ]) : void

Parameters

$cookie : string: The cookie name to check
$message : string = '': The failure message that will be appended to the generated message.

assertDirectoryDoesNotExist()

Asserts that a directory does not exist.


    public
            static        assertDirectoryDoesNotExist(string $directory[, string $message = '' ]) : void

Parameters

$directory : string: Directory
$message : string = '': Message

assertDoesNotMatchRegularExpression()

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


    public
            static        assertDoesNotMatchRegularExpression(string $pattern, string $string[, string $message = '' ]) : void

Parameters

$pattern : string: Regex pattern
$string : string: String to test
$message : string = '': Message

assertEqualsSql()

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


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

Parameters

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

assertEventFired()

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


    public
                    assertEventFired(string $name[, EventManager|null $eventManager = null ][, string $message = '' ]) : void

Parameters

$name : string: Event name
$eventManager : EventManager|null = null: Event manager to check, defaults to global event manager
$message : string = '': Assertion failure message

assertEventFiredWith()

Asserts an event was fired with data


    public
                    assertEventFiredWith(string $name, string $dataKey, mixed $dataValue[, EventManager|null $eventManager = null ][, string $message = '' ]) : void

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

Parameters

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

assertFileDoesNotExist()

Asserts that a file does not exist.


    public
            static        assertFileDoesNotExist(string $filename[, string $message = '' ]) : void

Parameters

$filename : string: Filename
$message : string = '': Message

assertFileResponse()

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


    public
                    assertFileResponse(string $expected[, string $message = '' ]) : void

Parameters

$expected : string: The absolute file path that should be sent in the response.
$message : string = '': The failure message that will be appended to the generated message.

assertFlashElement()

Asserts a flash element was set


    public
                    assertFlashElement(string $expected[, string $key = 'flash' ][, string $message = '' ]) : void

Parameters

$expected : string: Expected element name
$key : string = 'flash': Flash key
$message : string = '': Assertion failure message

assertFlashElementAt()

Asserts a flash element was set at a certain index


    public
                    assertFlashElementAt(int $at, string $expected[, string $key = 'flash' ][, string $message = '' ]) : void

Parameters

$at : int: Flash index
$expected : string: Expected element name
$key : string = 'flash': Flash key
$message : string = '': Assertion failure message

assertFlashMessage()

Asserts a flash message was set


    public
                    assertFlashMessage(string $expected[, string $key = 'flash' ][, string $message = '' ]) : void

Parameters

$expected : string: Expected message
$key : string = 'flash': Flash key
$message : string = '': Assertion failure message

assertFlashMessageAt()

Asserts a flash message was set at a certain index


    public
                    assertFlashMessageAt(int $at, string $expected[, string $key = 'flash' ][, string $message = '' ]) : void

Parameters

$at : int: Flash index
$expected : string: Expected message
$key : string = 'flash': Flash key
$message : string = '': Assertion failure message

assertHeader()

Asserts response headers


    public
                    assertHeader(string $header, string $content[, string $message = '' ]) : void

Parameters

$header : string: The header to check
$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertHeaderContains()

Asserts response header contains a string


    public
                    assertHeaderContains(string $header, string $content[, string $message = '' ]) : void

Parameters

$header : string: The header to check
$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertHeaderNotContains()

Asserts response header does not contain a string


    public
                    assertHeaderNotContains(string $header, string $content[, string $message = '' ]) : void

Parameters

$header : string: The header to check
$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertHtml()

Asserts HTML tags.


    public
                    assertHtml(array<string|int, mixed> $expected, string $string[, bool $fullDebug = false ]) : bool

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

$expected : array<string|int, mixed>: An array, see above
$string : string: An HTML/XHTML/XML string
$fullDebug : bool = false: Whether more verbose output should be used.

Return values

bool

assertLayout()

Asserts that the search string was in the layout name.


    public
                    assertLayout(string $content[, string $message = '' ]) : void

Parameters

$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertMatchesRegularExpression()

Asserts that a string matches a given regular expression.


    public
            static        assertMatchesRegularExpression(string $pattern, string $string[, string $message = '' ]) : void

Parameters

$pattern : string: Regex pattern
$string : string: String to test
$message : string = '': Message

assertNoRedirect()

Asserts that the Location header is not set.


    public
                    assertNoRedirect([string $message = '' ]) : void

Parameters

$message : string = '': The failure message that will be appended to the generated message.

assertRedirect()

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


    public
                    assertRedirect([array<string|int, mixed>|string|null $url = null ][, string $message = '' ]) : void

Parameters

$url : array<string|int, mixed>|string|null = 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.
$message : string = '': The failure message that will be appended to the generated message.

assertRedirectContains()

Asserts that the Location header contains a substring


    public
                    assertRedirectContains(string $url[, string $message = '' ]) : void

Parameters

$url : string: The URL you expected the client to go to.
$message : string = '': The failure message that will be appended to the generated message.

assertRedirectEquals()

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


    public
                    assertRedirectEquals([array<string|int, mixed>|string|null $url = null ][, string $message = '' ]) : void

Parameters

$url : array<string|int, mixed>|string|null = 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.
$message : string = '': The failure message that will be appended to the generated message.

assertRedirectNotContains()

Asserts that the Location header does not contain a substring


    public
                    assertRedirectNotContains(string $url[, string $message = '' ]) : void

Parameters

$url : string: The URL you expected the client to go to.
$message : string = '': The failure message that will be appended to the generated message.

assertRegExpSql()

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


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

Parameters

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

assertResponseCode()

Asserts a specific response status code.


    public
                    assertResponseCode(int $code[, string $message = '' ]) : void

Parameters

$code : int: Status code to assert.
$message : string = '': Custom message for failure.

assertResponseContains()

Asserts content exists in the response body.


    public
                    assertResponseContains(string $content[, string $message = '' ][, bool $ignoreCase = false ]) : void

Parameters

$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.
$ignoreCase : bool = false: A flag to check whether we should ignore case or not.

assertResponseEmpty()

Assert response content is empty.


    public
                    assertResponseEmpty([string $message = '' ]) : void

Parameters

$message : string = '': The failure message that will be appended to the generated message.

assertResponseEquals()

Asserts content in the response body equals.


    public
                    assertResponseEquals(mixed $content[, string $message = '' ]) : void

Parameters

$content : mixed: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertResponseError()

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


    public
                    assertResponseError([string $message = '' ]) : void

Parameters

$message : string = '': Custom message for failure.

assertResponseFailure()

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


    public
                    assertResponseFailure([string $message = '' ]) : void

Parameters

$message : string = '': Custom message for failure.

assertResponseNotContains()

Asserts content does not exist in the response body.


    public
                    assertResponseNotContains(string $content[, string $message = '' ][, bool $ignoreCase = false ]) : void

Parameters

$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.
$ignoreCase : bool = false: A flag to check whether we should ignore case or not.

assertResponseNotEmpty()

Assert response content is not empty.


    public
                    assertResponseNotEmpty([string $message = '' ]) : void

Parameters

$message : string = '': The failure message that will be appended to the generated message.

assertResponseNotEquals()

Asserts content in the response body not equals.


    public
                    assertResponseNotEquals(mixed $content[, string $message = '' ]) : void

Parameters

$content : mixed: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.

assertResponseNotRegExp()

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


    public
                    assertResponseNotRegExp(string $pattern[, string $message = '' ]) : void

Parameters

$pattern : string: The pattern to compare against.
$message : string = '': The failure message that will be appended to the generated message.

assertResponseOk()

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


    public
                    assertResponseOk([string $message = '' ]) : void

Parameters

$message : string = '': Custom message for failure.

assertResponseRegExp()

Asserts that the response body matches a given regular expression.


    public
                    assertResponseRegExp(string $pattern[, string $message = '' ]) : void

Parameters

$pattern : string: The pattern to compare against.
$message : string = '': The failure message that will be appended to the generated message.

assertResponseSuccess()

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


    public
                    assertResponseSuccess([string $message = '' ]) : void

Parameters

$message : string = '': Custom message for failure.

assertSession()

Asserts session contents


    public
                    assertSession(mixed $expected, string $path[, string $message = '' ]) : void

Parameters

$expected : mixed: The expected contents.
$path : string: The session data path. Uses Hash::get() compatible notation
$message : string = '': The failure message that will be appended to the generated message.

assertSessionHasKey()

Asserts session key exists.


    public
                    assertSessionHasKey(string $path[, string $message = '' ]) : void

Parameters

$path : string: The session data path. Uses Hash::get() compatible notation.
$message : string = '': The failure message that will be appended to the generated message.

assertSessionNotHasKey()

Asserts a session key does not exist.


    public
                    assertSessionNotHasKey(string $path[, string $message = '' ]) : void

Parameters

$path : string: The session data path. Uses Hash::get() compatible notation.
$message : string = '': The failure message that will be appended to the generated message.

assertTemplate()

Asserts that the search string was in the template name.


    public
                    assertTemplate(string $content[, string $message = '' ]) : void

Parameters

$content : string: The content to check for.
$message : string = '': The failure message that will be appended to the generated message.