Trait IntegrationTestTrait

_addTokens()source protected

_addTokens( string $url , array $data )

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

Параметры

string $url

URL, на который отправляется форма.

array $data

Данные тела запроса.

Возвращает

array
Тело запроса с добавленными токенами.

_buildRequest()source protected

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

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

Параметры

string|array $url

URL

string $method

HTTP-метод

string|array|null $data

Данные запроса.

Возвращает

array
Контекст запроса

_castToString()source protected

_castToString( array $data )

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

Параметры

array $data

Данные POST

Возвращает

array

_getBodyAsString()source protected

_getBodyAsString( )

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

Возвращает

string
Тело ответа.

_getCookieEncryptionKey()source protected

_getCookieEncryptionKey( )

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

Возвращает

string

_handleError()source protected

_handleError( Exception $exception )

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

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

Параметры

Exception $exception

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

Исключение

Exception

_makeDispatcher()source protected

_makeDispatcher( )

Получить экземпляр диспетчера.

Возвращает

Cake\TestSuite\MiddlewareDispatcher|Cake\TestSuite\LegacyRequestDispatcher
Экземпляр диспетчера

_sendRequest()source protected

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

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

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

Параметры

string|array $url

URL

string $method

HTTP-метод

string|array|null $data optional []

Данные запроса.

Исключение

PHPUnit\Exception

_url()source protected

_url( string|array $url )

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

Параметры

string|array $url

URL

Возвращает

array
Квалифицированный URL, параметры запроса и данные хоста

assertContentType()source public

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

Проверяет тип контента

Параметры

string $type

Тип контента, который нужно проверить.

string $message optional ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertCookie()source public

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

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

Параметры

string $expected

Ожидаемое содержимое.

string $name

Имя cookie.

string $message optional ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertCookieEncrypted()source public

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

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

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

Параметры

string $expected

Ожидаемое содержимое.

string $name

Имя cookie.

string|boolean $encrypt optional aes

Режим шифрования для использования.

string|null $key optional null

Ключ шифрования. По умолчанию Security.salt.

string $message optional ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

См.

\Cake\Utility\CookieCryptTrait::_encrypt()

assertCookieNotSet()source public

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

Проверка, что cookie не установлено в ответе

Параметры

string $cookie

Имя cookie, которое нужно проверить.

string $message optional ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertFileResponse()source public

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

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

Параметры

string $expected

Полный путь к файлу, который должен быть отправлен в ответе.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertFlashElement()source public

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

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

Параметры

string $expected

Ожидаемое имя элемента

string $key необязательно 'flash'

Ключ flash

string $message необязательно ''

Сообщение об ошибке проверки

assertFlashElementAt()source public

assertFlashElementAt( integer $at , string $expected , string $key = 'flash' , string $message = '' )

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

Параметры

integer $at

Индекс flash

string $expected

Ожидаемое имя элемента

string $key необязательно 'flash'

Ключ flash

string $message необязательно ''

Сообщение об ошибке проверки

assertFlashMessage()source public

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

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

Параметры

string $expected

Ожидаемое сообщение

string $key необязательно 'flash'

Ключ flash

string $message необязательно ''

Сообщение об ошибке проверки

assertFlashMessageAt()source public

assertFlashMessageAt( integer $at , string $expected , string $key = 'flash' , string $message = '' )

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

Параметры

integer $at

Индекс flash

string $expected

Ожидаемое сообщение

string $key необязательно 'flash'

Ключ flash

string $message необязательно ''

Сообщение об ошибке проверки

assertHeader()source public

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

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

Параметры

string $header

Заголовок для проверки

string $content

Содержимое для проверки.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertHeaderContains()source public

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

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

Параметры

string $header

Заголовок для проверки

string $content

Содержимое для проверки.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertHeaderNotContains()source public

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

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

Параметры

string $header

Заголовок для проверки

string $content

Содержимое для проверки.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertLayout()source public

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

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

Параметры

string $content

Содержимое для проверки.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertNoRedirect()source public

assertNoRedirect( string $message = '' )

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

Параметры

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertRedirect()source public

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

Утверждает, что заголовок Location правильный.

Параметры

string|array|null $url необязательно null

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

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertRedirectContains()source public

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

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

Параметры

string $url

Ожидаемый URL, на который должен перейти клиент.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertRedirectNotContains()source public

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

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

Параметры

string $url

Ожидаемый URL, на который должен перейти клиент.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseCode()source public

assertResponseCode( integer $code , string $message = null )

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

Параметры

integer $code

Код состояния для проверки.

string $message необязательно null

Пользовательское сообщение об ошибке.

assertResponseContains()source public

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

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

Параметры

string $content

Содержимое для проверки.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

boolean $ignoreCase необязательно false

Флаг для проверки, нужно ли игнорировать регистр или нет.

assertResponseEmpty()source public

assertResponseEmpty( string $message = '' )

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

Параметры

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseEquals()source public

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

Проверяет, что содержимое тела ответа равно указанному.

Параметры

mixed $content

Содержимое, которое нужно проверить.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseError()source public

assertResponseError( string $message = null )

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

Параметры

string $message необязательно null

Пользовательское сообщение об ошибке.

assertResponseFailure()source public

assertResponseFailure( string $message = null )

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

Параметры

string $message необязательно null

Пользовательское сообщение об ошибке.

assertResponseNotContains()source public

assertResponseNotContains( string $content , string $message = '' , boolean $ignoreCase = false )

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

Параметры

string $content

Содержимое, которое нужно проверить.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

boolean $ignoreCase необязательно false

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

assertResponseNotEmpty()source public

assertResponseNotEmpty( string $message = '' )

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

Параметры

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseNotEquals()source public

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

Проверяет, что содержимое тела ответа не равно указанному.

Параметры

mixed $content

Содержимое, которое нужно проверить.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseNotRegExp()source public

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

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

Параметры

string $pattern

Образец для сравнения.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseOk()source public

assertResponseOk( string $message = null )

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

Параметры

string $message необязательно null

Пользовательское сообщение об ошибке.

assertResponseRegExp()source public

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

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

Параметры

string $pattern

Образец для сравнения.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertResponseSuccess()source public

assertResponseSuccess( string $message = null )

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

Параметры

string $message необязательно null

Пользовательское сообщение об ошибке.

assertSession()source public

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

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

Параметры

string $expected

Ожидаемое содержимое.

string $path

Путь к данным сессии. Используется запись, совместимая с Hash::get()

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

assertTemplate()source public

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

Проверяет, что строка поиска присутствует в имени шаблона.

Параметры

string $content

Содержимое, которое нужно проверить.

string $message необязательно ''

Сообщение об ошибке, которое будет добавлено к сгенерированному сообщению.

cleanup()source public

cleanup( )

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

После

configApplication()source public

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

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

В сочетании с useHttpServer() для настройки имени класса и аргументов конструктора вашего класса приложения.

Параметры

string $class

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

array|null $constructorArgs

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

configRequest()source public

configRequest( array $data )

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

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

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

Параметры

array $data

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

controllerSpy()source public

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

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

Параметры

Cake\Event\Event $event

Событие диспетчера.

Cake\Controller\Controller|null $controller необязательно null

Экземпляр контроллера.

cookie()source public

cookie( string $name , mixed $value )

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

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

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

Параметры

string $name

Имя cookie, которое нужно использовать.

mixed $value

Значение cookie.

cookieEncrypted()source public

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

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

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

Параметры

строка $name

Имя куки-файла для использования.

смешанное $value

Значение куки-файла.

строка|логическое $encrypt необязательно 'aes'

Режим шифрования для использования.

строка|null $key необязательно null

Ключ шифрования, используемый. По умолчанию используется Security.salt.

См. также

\Cake\Utility\CookieCryptTrait::_encrypt()

delete()source public

delete( string|array $url )

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

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

Параметры

строка|массив $url

URL для запроса.

Исключения

PHPUnit\Exception

disableErrorHandlerMiddleware()source public

disableErrorHandlerMiddleware( )

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

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

enableCsrfToken()source public

enableCsrfToken( )

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

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

enableRetainFlashMessages()source public

enableRetainFlashMessages( )

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

enableSecurityToken()source public

enableSecurityToken( )

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

extractExceptionMessage()source protected

extractExceptionMessage( Exception $exception )

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

Параметры

Исключение $exception

Исключение для извлечения

Возвращает

строка

extractVerboseMessage()source protected

extractVerboseMessage( string $message = null )

Просмотр контроллера для извлечения возможных причин невыполненного утверждения

Параметры

строка $message необязательно null

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

Возвращает

null|строка

get()source public

get( string|array $url )

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

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

Параметры

строка|массив $url

URL для запроса.

Исключения

PHPUnit\Exception

head()source public

head( string|array $url )

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

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

Параметры

строка|массив $url

URL для запроса.

Исключения

PHPUnit\Exception

options()source public

options( string|array $url )

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

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

Параметры

строка|массив $url

URL для запроса.

Исключения

PHPUnit\Exception

patch()source public

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

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

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

Параметры

строка|массив $url

URL для запроса.

строка|массив|null $data необязательно []

Данные для запроса.

Исключения

PHPUnit\Exception

post()source public

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

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

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

Параметры

строка|массив $url

URL для запроса.

строка|массив|null $data необязательно []

Данные для запроса.

Исключения

PHPUnit\Exception

put()source public

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

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

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

Параметры

строка|массив $url

URL для запроса.

строка|массив|null $data необязательно []

Данные для запроса.

Исключения

PHPUnit\Exception

session()source public

session( array $data )

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

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

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

Параметры

массив $data

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

setUnlockedFields()source public

setUnlockedFields( array $unlockedFields = [] )

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

Параметры

массив $unlockedFields необязательно []

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

setupServer()source public

setupServer( )

Автоматически определяет, следует ли использовать стек HTTP middleware.

Перед

useHttpServer()source public

useHttpServer( boolean $enable )

Переключить использование стека HTTP Server.

Параметры

логическое $enable

Включить/отключить использование HTTP стека.

viewVariable()source public

viewVariable( string $name )

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

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

Параметры

строка $name

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

Возвращает

смешанный
Переменная представления, если задана.

_checkCipher()source protected

_checkCipher( string $encrypt )

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

Параметры

строка $encrypt

Имя шифра.

Выбрасывает

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

_decode()source protected

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

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

Параметры

строка $value

Значение для декодирования и расшифровки.

строка|ложь $encrypt

Используемый шифр шифрования.

строка|null $key

Используется в качестве защитного соли, если указано.

Возвращает

строка|массив
Декодированные значения.

_decrypt()source protected

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

Расшифровывает $value, используя метод public $type в классе Security

Параметры

массив $values

Значения для расшифровки

строка|булево $mode

Режим шифрования

строка|null $key опционально null

Используется в качестве защитного соли, если указано.

Возвращает

строка|массив
Расшифрованные значения

_encrypt()source protected

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

Шифрует $value, используя метод public $type в классе Security

Параметры

строка $value

Значение для шифрования

строка|булево $encrypt

Используемый режим шифрования. Ложь отключает шифрование.

строка|null $key опционально null

Используется в качестве защитного соли, если указано.

Возвращает

строка
Зашифрованные значения

_explode()source protected

_explode( string $string )

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

Параметры

строка $string

Строка, содержащая закодированные в JSON данные или обычная строка.

Возвращает

строка|массив
Карта ключей и значений

_implode()source protected

_implode( array $array )

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

Параметры

массив $array

Карта ключей и значений

Возвращает

строка
Строка, закодированная в JSON.

_buildFieldToken()source protected

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

Генерирует данные токена для предоставленных входных данных.

Параметры

строка $url

URL, по которому отправляется форма.

массив $fields

Если установлено, указывает список полей, используемых при генерации хэша.

массив $unlockedFields опционально []

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

Возвращает

массив
Данные токена.

[]

false

[]

false

false

[]

[]

false