Trait IntegrationTestTrait

Адаптер, предназначенный для упрощения интеграционных тестов контроллеров.

Этот класс тестов предоставляет ряд вспомогательных методов и функций, которые упрощают отправку запросов и проверку их ответов. Он отдает предпочтение полным интеграционным тестам перед объектами-моделями, поскольку позволяет протестировать больше кода и избежать некоторых проблем с обслуживанием, которые создают объекты-модели.

Пространство имён: Cake\TestSuite

Краткое описание свойств

$_appArgs protected

array|null

Настраиваемые аргументы конструктора приложения.
$_appClass protected

string|null

Настраиваемое имя класса приложения.
$_controller protected

Cake\Controller\Controller|null

Контроллер, используемый в последнем запросе.
$_cookie protected

array

Данные cookie для использования в следующем запросе.
$_cookieEncryptionKey protected

string|null
$_csrfKeyName protected

string

Имя, которое будет использоваться при получении токена csrf.
$_csrfToken protected

bool

Флажок boolean, указывающий, нужно ли добавлять токен CSRF в запрос.
$_exception protected

Throwable|null

Исключение, которое выбрасывается в случае.
$_flashMessages protected

array

Сохранённые всплывающие сообщения перед отображением.
$_layoutName protected

string

Последний отображенный макет.
$_request protected

array

Данные, используемые для построения следующего запроса.
$_requestSession protected

Cake\Http\Session

Экземпляр сессии из последнего запроса.
$_response protected

Psr\Http\Message\ResponseInterface|null

Ответ на последний запрос.
$_retainFlashMessages protected

bool

Флажок boolean, указывающий, нужно ли повторно сохранять всплывающие сообщения.
$_securityToken protected

bool

Флажок boolean, указывающий, нужно ли добавлять токен SecurityComponent в запрос.
$_session protected

array

Данные сессии для использования в следующем запросе.
$_unlockedFields protected

array<string>

Список полей, исключённых из проверки полей.
$_validCiphers protected

array<string>

Допустимые имена шифров для зашифрованных файлов cookie.
$_viewName protected

string

Последний отображенный вид.

Краткое описание методов

_addTokens() protected

Добавить токены CSRF и компонента безопасности, если необходимо.
_buildRequest() protected

Создаёт объект запроса с настроенными опциями и параметрами.
_castToString() protected

Рекурсивно преобразует все данные в строку, так как именно таким образом данные передаются в POST запросе.
_checkCipher() protected

Вспомогательный метод для проверки имен шифров шифрования.
_decode() protected

Декодирует и расшифровывает одно значение.
_decrypt() protected

Расшифровывает $value с помощью метода public $type в классе Security.
_encrypt() protected

Шифрует $value с помощью метода public $type в классе Security.
_explode() protected

Метод explode для возврата массива из строки, установленной в CookieComponent::_implode(). Сохраняет обратную совместимость с методом CookieComponent::_implode() версии 1.x.
_getBodyAsString() protected

Получить тело ответа в виде строки.
_getCookieEncryptionKey() protected

Возвращает ключ шифрования, который будет использоваться.
_handleError() protected

Попытка отобразить ответ об ошибке для заданного исключения.
_implode() protected

Метод implode для сохранения ключей многомерных массивов.
_makeDispatcher() protected

Получить правильный экземпляр диспетчера.
_sendRequest() protected

Создаёт и отправляет запрос в экземпляр Dispatcher.
_url() protected

Создаёт корректный URL запроса и массив параметров, аналогично Request::_url().
assertContentType() public

Проверяет тип контента.
assertCookie() public

Проверяет значения куки.
assertCookieEncrypted() public

Проверяет значения куки, зашифрованные компонентом CookieComponent.
assertCookieNotSet() public

Проверяет, что куки не установлены в ответе.
assertFileResponse() public

Проверяет, что файл с указанным именем был отправлен в ответе.
assertFlashElement() public

Проверяет, что элемент всплывающего сообщения был установлен.
assertFlashElementAt() public

Проверяет, что элемент всплывающего сообщения был установлен на определённом индексе.
assertFlashMessage() public

Проверяет, что сообщение всплывающего сообщения было установлено.
assertFlashMessageAt() public

Проверяет, что сообщение всплывающего сообщения было установлено на определённом индексе.
assertHeader() public

Проверяет заголовки ответа.
assertHeaderContains() public

Проверяет, что заголовок ответа содержит строку.
assertHeaderNotContains() public

Проверяет, что заголовок ответа не содержит строку.
assertLayout() public

Проверяет, что поисковая строка находилась в имени макета.
assertNoRedirect() public

Проверяет, что заголовок Location не установлен.
assertRedirect() public

Проверяет, что заголовок Location корректен. Сравнение производится с полным URL.
assertRedirectContains() public

Проверяет, что заголовок Location содержит подстроку.
assertRedirectEquals() public

Проверяет, что заголовок Location корректен. Сравнение производится с точным указанным URL.
assertRedirectNotContains() public

Проверяет, что заголовок Location не содержит подстроку.
assertResponseCode() public

Проверяет определённый код состояния ответа.
assertResponseContains() public

Проверяет, что содержимое существует в теле ответа.
assertResponseEmpty() public

Проверить, что содержимое ответа пустое.
assertResponseEquals() public

Проверяет, что содержимое в теле ответа равно.
assertResponseError() public

Проверяет, что код состояния ответа находится в диапазоне 4xx.
assertResponseFailure() public

Проверяет, что код состояния ответа находится в диапазоне 5xx.
assertResponseNotContains() public

Проверяет, что содержимое не существует в теле ответа.
assertResponseNotEmpty() public

Проверьте, что содержимое ответа не пустое.
assertResponseNotEquals() public

Проверяет, что содержимое в теле ответа не равно.
assertResponseNotRegExp() public

Проверяет, что тело ответа не соответствует заданному регулярному выражению.
assertResponseOk() public

Проверяет, что код состояния ответа находится в диапазоне 2xx.
assertResponseRegExp() public

Проверяет, что тело ответа соответствует заданному регулярному выражению.
assertResponseSuccess() public

Проверяет, что код состояния ответа находится в диапазоне 2xx/3xx.
assertSession() public

Проверяет содержимое сессии.

assertSessionHasKey() public

Проверяет существование ключа сессии.
assertSessionNotHasKey() public

Проверяет отсутствие ключа сессии.
assertTemplate() public

Проверяет, что строка поиска была в имени шаблона.
cleanup() public

Очищает состояние, используемое для запросов.
cleanupContainer() public

Очищает все созданные подстановки и очищает конфигурацию приложения.
configApplication() public

Настроить класс приложения для использования в интеграционных тестах.
configRequest() public

Настраивает данные для следующего запроса.
controllerSpy() public

Добавляет дополнительные шпионы событий в менеджер событий контроллера/представления.
cookie() public

Устанавливает куки запроса для будущих запросов.
cookieEncrypted() public

Устанавливает зашифрованную куки запроса для будущих запросов.
createApp() protected

Создать экземпляр приложения.
delete() public

Выполняет запрос DELETE с использованием текущих данных запроса.
disableErrorHandlerMiddleware() public

Отключить обработчик ошибок middleware.
enableCsrfToken() public

Вызов этого метода добавит маркер CSRF к запросу.
enableRetainFlashMessages() public

Вызов этого метода позволит сохранить сообщения flash в сессии теста после удаления FlashHelper
enableSecurityToken() public

Вызов этого метода включит совместимый с SecurityComponent токен, который будет добавлен в данные запроса. Это позволяет легко тестировать действия, защищенные SecurityComponent.
extractExceptionMessage() protected

Извлечь подробное сообщение для существующего исключения
extractVerboseMessage() protected

Просмотреть контроллер, чтобы извлечь возможные причины неудачного утверждения
get() public

Выполняет запрос GET с использованием текущих данных запроса.
getSession() protected
head() public

Выполняет запрос HEAD с использованием текущих данных запроса.
mockService() public

Добавить имитируемую службу в контейнер.
modifyContainer() public

Обернуть контейнер приложения контейнером, содержащим подстановки.
options() public

Выполняет запрос OPTIONS с использованием текущих данных запроса.
patch() public

Выполняет запрос PATCH с использованием текущих данных запроса.
post() public

Выполняет запрос POST с использованием текущих данных запроса.
put() public

Выполняет запрос PUT с использованием текущих данных запроса.
removeMockService() public

Удалить имитируемую службу из контейнера.
session() public

Устанавливает данные сессии.
setUnlockedFields() public

Установить список полей, исключенных из валидации полей.
viewVariable() public

Извлекает переменную представления по имени.

Подробное описание методов

_addTokens() защищённый

_addTokens(string $url, array $data): array

Добавить токены CSRF и компонента безопасности, если необходимо.

Параметры

string $url: URL, на который отправляется форма.
array $data: Данные тела запроса.

Возвращаемое значение

array

_buildRequest() защищённый

_buildRequest(string $url, string $method, array|string $data = []): array

Создаёт объект запроса с настроенными опциями и параметрами.

Параметры

string $url: URL
string $method: Метод HTTP
array|string $data необязательно: Данные запроса.

Возвращаемое значение

array

_castToString() защищённый

_castToString(array $data): array

Рекурсивно преобразует все данные в строковый тип, так как данные передаются в POST запросе в реальном мире

Параметры

array $data: Данные POST

Возвращаемое значение

array

_checkCipher() защищённый

_checkCipher(string $encrypt): void

Вспомогательный метод для проверки имён шифров шифрования.

Параметры

string $encrypt: Имя шифра.

Возвращаемое значение

void

Исключения

RuntimeException
При предоставлении недопустимого шифра.

_decode() защищённый

_decode(string $value, string|false $encrypt, string|null $key): array|string

Декодирует и расшифровывает одно значение.

Параметры

string $value: Значение для декодирования и расшифрования.
string|false $encrypt: Используемый шифр шифрования.
string|null $key: Используется в качестве защитного ключа, если указано.

Возвращаемое значение

array|string

_decrypt() защищённый

_decrypt(array<string>|string $values, string|false $mode, string|null $key = null): array|string

Расшифровывает $value с помощью публичного метода $type в классе Security

Параметры

array<string>|string $values: Значения для расшифрования
string|false $mode: Режим шифрования
string|null $key необязательно: Используется в качестве защитного ключа, если указано.

Возвращаемое значение

array|string

_encrypt() защищённый

_encrypt(array|string $value, string|false $encrypt, string|null $key = null): string

Шифрует $value с помощью публичного метода $type в классе Security

Параметры

array|string $value: Значение для шифрования
string|false $encrypt: Режим шифрования для использования. False отключит шифрование.
string|null $key необязательно: Используется в качестве защитного ключа, если указано.

Возвращаемое значение

string

_explode() защищённый

_explode(string $string): array|string

Метод explode для возврата массива из строки, заданной в CookieComponent::_implode() Сохраняет обратную совместимость с чтением в обратном порядке с CookieComponent::_implode() версии 1.x.

Параметры

string $string: Строка, содержащая данные в формате JSON, закодированные, или просто строка.

Возвращаемое значение

array|string

_getBodyAsString() защищённый

_getBodyAsString(): string

Получить тело ответа в виде строки

Возвращаемое значение

string

_getCookieEncryptionKey() защищённый

_getCookieEncryptionKey(): string

Возвращает ключ шифрования, который будет использоваться.

Возвращаемое значение

string

_handleError() защищённый

_handleError(Throwable $exception): void

Попытка отобразить ответ об ошибке для заданного исключения.

Этот метод попытается использовать настроенный обработчик исключений. Если такой класс не существует, будет использован встроенный обработчик.

Параметры

Throwable $exception: Исключение для обработки.

Возвращаемое значение

void

_implode() защищённый

_implode(array $array): string

Метод implode, для поддержания ключей в многомерных массивах.

Параметры

array $array: Карта ключей и значений.

Возвращаемое значение

string

_makeDispatcher() защищённый

_makeDispatcher(): Cake\TestSuite\MiddlewareDispatcher

Получить правильную инстанцию диспетчера.

Возвращаемое значение

Cake\TestSuite\MiddlewareDispatcher

_sendRequest() защищённый

_sendRequest(array|string $url, string $method, array|string $data = []): void

Создаёт и отправляет запрос в инстанцию Dispatcher.

Принимает и сохраняет ответ для дальнейшего анализа.

Параметры

array|string $url: URL
string $method: Метод HTTP
array|string $data необязательно: Данные запроса.

Возвращаемое значение

void

Исключения

PHPUnit\ExceptionThrowable

_url() защищённый

_url(string $url): array

Создаёт допустимый URL запроса и массив параметров, более похожий на Request::_url()

Параметры

string $url: URL

Возвращаемое значение

array

assertContentType() публичный

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

Проверяет тип содержимого

Параметры

string $type: Тип содержимого, который нужно проверить.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращаемое значение

void

assertCookie() публичный

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

Проверяет значения cookie

Параметры

mixed $expected: Ожидаемое содержимое.
string $name: Имя cookie.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращаемое значение

void

assertCookieEncrypted() публичный

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

Проверяет значения cookie, зашифрованные компонентом CookieComponent.

Разница с assertCookie() заключается в том, что это расшифровывает значение cookie, как и компонент CookieComponent, для этой проверки.

Параметры

mixed $expected: Ожидаемое содержимое.
string $name: Имя cookie.
string $encrypt необязательно: Режим шифрования для использования.
string|null $key необязательно: Ключ шифрования. По умолчанию используется Security.salt.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращаемое значение

void

См. также

\Cake\Utility\CookieCryptTrait::_encrypt()

assertCookieNotSet() public

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

Утверждает, что куки не был установлен в ответе

Параметры

string $cookie: Имя куки для проверки
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertFileResponse() public

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

Утверждает, что файл с заданным именем был отправлен в ответе

Параметры

string $expected: Абсолютный путь к файлу, который должен быть отправлен в ответе.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertFlashElement() public

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

Утверждает, что элемент flash был установлен

Параметры

string $expected: Ожидаемое имя элемента
string $key необязательно: Ключ flash
string $message необязательно: Сообщение об ошибке утверждения

Возвращает

void

assertFlashElementAt() public

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

Утверждает, что элемент flash был установлен в определенном индексе

Параметры

int $at: Индекс flash
string $expected: Ожидаемое имя элемента
string $key необязательно: Ключ flash
string $message необязательно: Сообщение об ошибке утверждения

Возвращает

void

assertFlashMessage() public

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

Утверждает, что сообщение flash было установлено

Параметры

string $expected: Ожидаемое сообщение
string $key необязательно: Ключ flash
string $message необязательно: Сообщение об ошибке утверждения

Возвращает

void

assertFlashMessageAt() public

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

Утверждает, что сообщение flash было установлено в определенном индексе

Параметры

int $at: Индекс flash
string $expected: Ожидаемое сообщение
string $key необязательно: Ключ flash
string $message необязательно: Сообщение об ошибке утверждения

Возвращает

void

assertHeader() public

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

Утверждает заголовки ответа

Параметры

string $header: Заголовок для проверки
string $content: Контент, который нужно проверить.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertHeaderContains() public

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

Утверждает, что заголовок ответа содержит строку

Параметры

string $header: Заголовок для проверки
string $content: Контент, который нужно проверить.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertHeaderNotContains() public

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

Утверждает, что заголовок ответа не содержит строку

Параметры

string $header: Заголовок для проверки
string $content: Контент, который нужно проверить.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertLayout() public

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

Утверждает, что поисковая строка была в имени макета.

Параметры

string $content: Контент, который нужно проверить.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertNoRedirect() public

assertNoRedirect(string $message = ''): void

Утверждает, что заголовок Location не установлен.

Параметры

string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertRedirect() public

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

Утверждает, что заголовок Location правильный. Сравнение выполняется по полному URL.

Параметры

array|string|null $url необязательно: Ожидаемый URL, куда перенаправит клиент. Это может быть строка URL или массив, совместимый с Router::url(). Используйте null, чтобы просто проверить наличие этого заголовка.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertRedirectContains() public

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

Утверждает, что заголовок Location содержит подстроку

Параметры

string $url: Ожидаемый URL, куда перенаправит клиент.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertRedirectEquals() public

assertRedirectEquals(array|string|null $url = null, string $message = ''): void

Утверждает, что заголовок Location правильный. Сравнение выполняется по предоставленному URL.

Параметры

array|string|null $url необязательно: Ожидаемый URL, куда перенаправит клиент. Это может быть строка URL или массив, совместимый с Router::url(). Используйте null, чтобы просто проверить наличие этого заголовка.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertRedirectNotContains() public

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

Утверждает, что заголовок Location не содержит подстроку

Параметры

string $url: Ожидаемый URL, куда перенаправит клиент.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseCode() public

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

Утверждает определенный код состояния ответа.

Параметры

int $code: Код состояния для проверки.
string $message необязательно: Пользовательское сообщение об ошибке.

Возвращает

void

assertResponseContains() public

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

Утверждает, что содержимое существует в теле ответа.

Параметры

string $content: Содержимое для проверки.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.
bool $ignoreCase необязательно: Флаг для проверки, нужно ли игнорировать регистр.

Возвращает

void

assertResponseEmpty() public

assertResponseEmpty(string $message = ''): void

Утверждает, что содержимое ответа пустое.

Параметры

string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseEquals() public

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

Утверждает, что содержимое в теле ответа равно.

Параметры

mixed $content: Содержимое для проверки.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseError() public

assertResponseError(string $message = ''): void

Утверждает, что код состояния ответа находится в диапазоне 4xx.

Параметры

string $message необязательно: Пользовательское сообщение об ошибке.

Возвращает

void

assertResponseFailure() public

assertResponseFailure(string $message = ''): void

Утверждает, что код состояния ответа находится в диапазоне 5xx.

Параметры

string $message необязательно: Пользовательское сообщение об ошибке.

Возвращает

void

assertResponseNotContains() public

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

Утверждает, что содержимое не существует в теле ответа.

Параметры

string $content: Содержимое для проверки.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.
bool $ignoreCase необязательно: Флаг для проверки, нужно ли игнорировать регистр.

Возвращает

void

assertResponseNotEmpty() public

assertResponseNotEmpty(string $message = ''): void

Утверждает, что содержимое ответа не пустое.

Параметры

string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseNotEquals() public

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

Утверждает, что содержимое в теле ответа не равно.

Параметры

mixed $content: Содержимое для проверки.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseNotRegExp() public

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

Утверждает, что тело ответа не соответствует заданному регулярному выражению.

Параметры

string $pattern: Шаблон для сравнения.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseOk() public

assertResponseOk(string $message = ''): void

Утверждает, что код состояния ответа находится в диапазоне 2xx.

Параметры

string $message необязательно: Пользовательское сообщение об ошибке.

Возвращает

void

assertResponseRegExp() public

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

Утверждает, что тело ответа соответствует заданному регулярному выражению.

Параметры

string $pattern: Шаблон для сравнения.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertResponseSuccess() public

assertResponseSuccess(string $message = ''): void

Утверждает, что код состояния ответа находится в диапазоне 2xx/3xx.

Параметры

string $message необязательно: Пользовательское сообщение об ошибке.

Возвращает

void

assertSession() public

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

Утверждает содержимое сессии.

Параметры

mixed $expected: Ожидаемое содержимое.
string $path: Путь к данным сессии. Используется нотация, совместимая с Hash::get()
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertSessionHasKey() public

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

Утверждает, что ключ сессии существует.

Параметры

string $path: Путь к данным сессии. Используется нотация, совместимая с Hash::get().
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertSessionNotHasKey() public

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

Утверждает, что ключ сессии не существует.

Параметры

string $path: Путь к данным сессии. Используется нотация, совместимая с Hash::get().
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

assertTemplate() public

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

Утверждает, что строка поиска была в имени шаблона.

Параметры

string $content: Содержимое для проверки.
string $message необязательно: Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

Возвращает

void

cleanup() public

cleanup(): void

Очищает состояние, используемое для запросов.

Возвращает

void

cleanupContainer() public

cleanupContainer(): void

Очищает любые заданные моки и очищает конфигурацию приложения.

Возвращает

void

configApplication() public

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

Настроить класс приложения для использования в интеграционных тестах.

Параметры

string $class: Имя класса приложения.
array|null $constructorArgs: Аргументы конструктора для вашего класса приложения.

Возвращает

void

configRequest() public

configRequest(array $data): void

Настраивает данные для следующего запроса.

Эти данные очищаются в методе tearDown().

Вы можете вызывать этот метод несколько раз, чтобы добавить данные в текущее состояние. Однако подключаемые ключи, такие как 'headers', будут сброшены.

Параметры

array $data: Данные запроса, которые нужно использовать.

Возвращает

void

controllerSpy() public

controllerSpy(Cake\Event\EventInterface $event, Cake\Controller\Controller|null $controller = null): void

Добавляет дополнительные шпионы событий в диспетчер событий контроллера/представления.

Параметры

Cake\Event\EventInterface $event: Событие диспетчера.
Cake\Controller\Controller|null $controller optional: Экземпляр контроллера.

Возвращает

void

cookie(string $name, mixed $value): void

Устанавливает куку запроса для будущих запросов.

Этот метод позволяет настроить данные сеанса, которые будут использоваться для последующих запросов. Состояние сеанса сбрасывается в каждом tearDown().

Вы можете вызывать этот метод несколько раз, чтобы добавить данные в текущее состояние.

Параметры

string $name: Имя куки, которое нужно использовать.
mixed $value: Значение куки.

Возвращает

void

cookieEncrypted() public

cookieEncrypted(string $name, mixed $value, string|false $encrypt = 'aes', string|null $key = null): void

Устанавливает зашифрованную куку запроса для будущих запросов.

Отличие от cookie() заключается в том, что это шифрует значение куки, как CookieComponent.

Параметры

string $name: Имя куки, которое нужно использовать.
mixed $value: Значение куки.
string|false $encrypt optional: Режим шифрования для использования.
string|null $key optional: Ключ шифрования, используемый. По умолчанию Security.salt.

Возвращает

void

См. также

\Cake\Utility\CookieCryptTrait::_encrypt()

createApp() protected

createApp(): Cake\Core\HttpApplicationInterfaceCake\Core\ConsoleApplicationInterface

Создаёт экземпляр приложения.

Использует конфигурацию, заданную в configApplication().

Возвращает

Cake\Core\HttpApplicationInterfaceCake\Core\ConsoleApplicationInterface

delete() public

delete(array|string $url): void

Выполняет запрос DELETE, используя текущие данные запроса.

Ответ на обработанный запрос будет сохранён как свойство. Вы можете использовать различные методы проверки для проверки ответа.

Параметры

array|string $url: URL для запроса.

Возвращает

void

disableErrorHandlerMiddleware() public

disableErrorHandlerMiddleware(): void

Отключает обработчик ошибок middleware.

Используя эту функцию, исключения больше не ловятся ErrorHandlerMiddleware, а вместо этого повторно выбрасываются TestExceptionRenderer. Это может быть полезно при диагностике/отладке неожиданных сбоев в тестовых случаях.

Возвращает

void

enableCsrfToken() public

enableCsrfToken(string $cookieName = 'csrfToken'): void

Вызов этого метода добавит токен CSRF в запрос.

И данные POST, и куку будут заполнены, если этот параметр включён. Будут использованы параметры по умолчанию.

Параметры

string $cookieName optional: Имя куки токена CSRF.

Возвращает

void

enableRetainFlashMessages() public

enableRetainFlashMessages(): void

Вызов этого метода повторно сохранит сообщения flash в сеанс теста после удаления FlashHelper

Возвращает

void

enableSecurityToken() public

enableSecurityToken(): void

Вызов этого метода включит совместимый с SecurityComponent токен, который будет добавлен в данные запроса. Это позволяет легко тестировать действия, защищённые SecurityComponent.

Возвращает

void

extractExceptionMessage() protected

extractExceptionMessage(Exception $exception): string

Извлечь подробное сообщение для существующего исключения

Параметры

Exception $exception: Исключение для извлечения

Возвращает

string

extractVerboseMessage() protected

extractVerboseMessage(string $message): string

Проверить контроллер, чтобы извлечь возможные причины неудачи утверждения

Параметры

string $message: Исходное сообщение, которое нужно использовать в качестве основы

Возвращает

string

get() public

get(array|string $url): void

Выполняет запрос GET, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.

Возвращает

void

getSession() protected

getSession(): Cake\TestSuite\TestSession

Возвращает

Cake\TestSuite\TestSession

head() public

head(array|string $url): void

Выполняет запрос HEAD, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.

Возвращает

void

mockService() public

mockService(string $class, Closure $factory): $this

Добавить смокированный сервис в контейнер.

При создании контейнера предоставленное имя класса будет сопоставлено с фабричной функцией. Фабричная функция будет использоваться для создания смокированных сервисов.

Параметры

string $class: Класс или интерфейс, который вы хотите определить.
Closure $factory: Фабричная функция для смокированных сервисов.

Возвращает

$this

modifyContainer() public

modifyContainer(Cake\Event\EventInterface $event, Cake\Core\ContainerInterface $container): Cake\Core\ContainerInterface|null

Оборачивает контейнер приложения контейнером, содержащим эмуляции.

Если определены какие-либо эмулированные сервисы, контейнер приложения будет заменён контейнером, содержащим эмуляции. Исходный контейнер будет установлен в качестве делегата контейнера эмуляции.

Параметры

Cake\Event\EventInterface $event: Событие
Cake\Core\ContainerInterface $container: Контейнер для оборачивания.

Возвращает

Cake\Core\ContainerInterface|null

options() public

options(array|string $url): void

Выполняет запрос OPTIONS, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.

Возвращает

void

patch() public

patch(array|string $url, array|string $data = []): void

Выполняет PATCH-запрос, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.
array|string $data optional: Данные для запроса.

Возвращает

void

post() public

post(array|string $url, array|string $data = []): void

Выполняет POST-запрос, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.
array|string $data optional: Данные для запроса.

Возвращает

void

put() public

put(array|string $url, array|string $data = []): void

Выполняет PUT-запрос, используя текущие данные запроса.

Параметры

array|string $url: URL для запроса.
array|string $data optional: Данные для запроса.

Возвращает

void

removeMockService() public

removeMockService(string $class): $this

Удаляет эмулированный сервис из контейнера.

Параметры

string $class: Класс или интерфейс, который требуется удалить.

Возвращает

$this

session() public

session(array $data): void

Устанавливает данные сессии.

Этот метод позволяет настроить данные сессии, которые должны использоваться для последующих запросов. Состояние сессии сбрасывается в каждом tearDown().

Вы можете вызывать этот метод несколько раз, чтобы добавлять в текущее состояние.

Параметры

array $data: Данные сессии для использования.

Возвращает

void

setUnlockedFields() public

setUnlockedFields(array<string> $unlockedFields = []): void

Устанавливает список полей, исключённых из валидации.

Параметры

array<string> $unlockedFields optional: Список полей, исключённых из валидации.

Возвращает

void

viewVariable() public

viewVariable(string $name): mixed

Получает переменную представления по имени.

Если переменная представления не существует, возвращается null.

Параметры

string $name: Переменная представления для получения.

Возвращает

mixed

Подробности свойства

`$_appArgs` protected

Настроенные аргументы конструктора приложения.

Тип

array|null

`$_appClass` protected

Настроенное имя класса приложения.

Тип

string|null

`$_controller` protected

Контроллер, используемый в последнем запросе.

Тип

Cake\Controller\Controller|null

`$_cookie` protected

Данные cookie для использования в следующем запросе.

Тип

array

`$_cookieEncryptionKey` protected

Тип

string|null

`$_csrfKeyName` protected

Имя, которое будет использоваться при получении токена csrf.

Тип

string

`$_csrfToken` protected

Флаг булевого типа, указывающий, нужно ли добавлять токен CSRF в запрос.

Тип

bool

`$_exception` protected

Исключение, которое выбрасывается в случае чего.

Тип

Throwable|null

`$_flashMessages` protected

Сохраненные всплывающие сообщения перед рендерингом

Тип

array

`$_layoutName` protected

Последний рендер шаблона

Тип

string

`$_request` protected

Данные, используемые для построения следующего запроса.

Тип

array

`$_requestSession` protected

Экземпляр сессии из последнего запроса

Тип

Cake\Http\Session

`$_response` protected

Ответ на последний запрос.

Тип

Psr\Http\Message\ResponseInterface|null

`$_retainFlashMessages` protected

Флаг булевого типа, указывающий, нужно ли повторно сохранять всплывающие сообщения.

Тип

bool

`$_securityToken` protected

Флаг булевого типа, указывающий, нужно ли добавлять токен SecurityComponent в запрос.

Тип

bool

`$_session` protected

Данные сессии для использования в следующем запросе.

Тип

array

`$_unlockedFields` protected

Список полей, исключенных из проверки валидации.

Тип

array<string>

`$_validCiphers` protected

Допустимые имена шифров для зашифрованных cookie.

Тип

array<string>

`$_viewName` protected

Последний рендер представления

Тип

string

© 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.4/trait-Cake.TestSuite.IntegrationTestTrait.html

Trait IntegrationTestTrait

Краткое описание свойств

Краткое описание методов

_addTokens() protected

_buildRequest() protected

_castToString() protected

_checkCipher() protected

_decode() protected

_decrypt() protected

_encrypt() protected

_explode() protected

_getBodyAsString() protected

_getCookieEncryptionKey() protected

_handleError() protected

_implode() protected

_makeDispatcher() protected

_sendRequest() protected

_url() protected

assertContentType() public

assertCookie() public

assertCookieEncrypted() public

assertCookieNotSet() public

assertFileResponse() public

assertFlashElement() public

assertFlashElementAt() public

assertFlashMessage() public

assertFlashMessageAt() public

assertHeader() public

assertHeaderContains() public

assertHeaderNotContains() public

assertLayout() public

assertNoRedirect() public

assertRedirect() public

assertRedirectContains() public

assertRedirectEquals() public

assertRedirectNotContains() public

assertResponseCode() public

assertResponseContains() public

assertResponseEmpty() public

assertResponseEquals() public

assertResponseError() public

assertResponseFailure() public

assertResponseNotContains() public

assertResponseNotEmpty() public

assertResponseNotEquals() public

assertResponseNotRegExp() public

assertResponseOk() public

assertResponseRegExp() public

assertResponseSuccess() public

assertSession() public

assertSessionHasKey() public

assertSessionNotHasKey() public

assertTemplate() public

cleanup() public

cleanupContainer() public

configApplication() public

configRequest() public

controllerSpy() public

cookie() public

cookieEncrypted() public

createApp() protected

delete() public

disableErrorHandlerMiddleware() public

enableCsrfToken() public

enableRetainFlashMessages() public

enableSecurityToken() public

extractExceptionMessage() protected

extractVerboseMessage() protected

get() public

getSession() protected

head() public

mockService() public

modifyContainer() public

options() public

patch() public

post() public

put() public

removeMockService() public

session() public

setUnlockedFields() public