Spec-Zone.ru › CakePHP 4.2

Класс CookieEncryptedEquals

CookieEncryptedEquals

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

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

  • $_validCiphers protected
    string[]

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

  • $cookieName protected
    string
  • $key protected
    string
  • $mode protected
    string
  • $response protected
    Cake\Http\Response

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

  • __construct() public

    Конструктор.

  • _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

    Возвращает ключ шифрования

  • _implode() protected

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

  • additionalFailureDescription() protected

    Возвращает дополнительное описание ошибки, когда это необходимо.

  • count() public

    Подсчитывает количество элементов ограничения.

  • evaluate() public

    Оценивает ограничение для параметра $other.

  • exporter() protected
  • fail() protected

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

  • failureDescription() protected

    Возвращает описание ошибки.

  • failureDescriptionInContext() protected

    Возвращает описание ошибки, когда данное ограничение появляется в контексте выражения $operator.

  • matches() public

    Проверяет утверждение

  • reduce() protected

    Уменьшает подвыражение, начиная с $this, пропуская вырожденные подвыражения, и возвращает первое ограничение потомка, которое начинается с несокращаемого подвыражения.

  • toString() public

    Сообщение утверждения

  • toStringInContext() protected

    Возвращает настраиваемое строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.

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

__construct() public 

__construct(Cake\Http\Response|null $response, string $cookieName, string $mode, string $key)

Конструктор.

Параметры

Cake\Http\Response|null $response

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

string $cookieName

Имя cookie

string $mode

Режим

string $key

Ключ

_checkCipher() protected 

_checkCipher(string $encrypt): void

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

Параметры

string $encrypt

Имя шифра.

Возвращает

void

Выбрасывает

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

_decode() protected 

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

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

Параметры

string $value

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

string|false $encrypt

Шифр шифрования, который нужно использовать.

string|null $key

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

Возвращает

string|array

_decrypt() protected 

_decrypt(string[]|string $values, string|false $mode, string|null $key = null): string|array

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

Параметры

string[]|string $values

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

string|false $mode

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

string|null $key optional

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

Возвращает

string|array

_encrypt() protected 

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

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

Параметры

string|array $value

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

string|false $encrypt

Режим шифрования. False - отключение шифрования.

string|null $key optional

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

Возвращает

string

_explode() protected 

_explode(string $string): string|array

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

Параметры

string $string

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

Возвращает

string|array

_getBodyAsString() protected 

_getBodyAsString(): string

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

Возвращает

string

_getCookieEncryptionKey() protected 

_getCookieEncryptionKey(): string

Возвращает ключ шифрования

Возвращает

string

_implode() protected 

_implode(array $array): string

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

Параметры

array $array

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

Возвращает

string

additionalFailureDescription() protected 

additionalFailureDescription(mixed $other): string

Возвращает дополнительное описание ошибки, если нужно.

Функция может быть переопределена для предоставления дополнительной информации об ошибке, например, diff.

Параметры

mixed $other

оцениваемое значение или объект

Возвращает

string

count() public 

count(): int

Подсчитывает количество элементов ограничений.

Возвращает

int

evaluate() public 

evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool

Оценивает ограничение для параметра $other.

Если $returnResult установлен в false (по умолчанию), при ошибке выбрасывается исключение. В противном случае возвращается null.

Если $returnResult установлен в true, результат оценки возвращается в виде логического значения: true в случае успеха, false в случае ошибки.

Параметры

$other
string $description optional
bool $returnResult optional

Возвращает

?bool

Выбрасывает

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

exporter() protected 

exporter(): Exporter

Возвращает

Exporter

fail() protected 

fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null): void

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

Параметры

mixed $other

оцениваемое значение или объект

string $description

Дополнительная информация о тесте

ComparisonFailure $comparisonFailure optional

Возвращает

void

Выбрасывает

SebastianBergmann\RecursionContext\InvalidArgumentException

ExpectationFailedException

failureDescription() protected 

failureDescription(mixed $other): string

Возвращает описание ошибки.

В большинстве случаев начало сообщений об ошибках — «Failed asserting that». Этот метод должен возвращать вторую часть этого предложения.

Для предоставления дополнительной информации об ошибке можно использовать additionalFailureDescription.

Параметры

mixed $other

оцениваемое значение или объект

Возвращает

string

Выбрасывает

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescriptionInContext() protected 

failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string

Возвращает описание ошибки, когда это ограничение появляется в контексте выражения $operator.

Цель этого метода — предоставить осмысленное описание ошибки в контексте операторов, таких как LogicalNot. Собственные ограничения PHPUnit поддерживаются из коробки LogicalNot, но внешние разработанные не имели способа предоставить правильные сообщения в этом контексте.

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

Параметры

Operator $operator

оператор $operator выражения

mixed $role

роль ограничения $this в выражении $operator

mixed $other

оцениваемое значение или объект

Возвращает

string

matches() public 

matches(mixed $other): bool

Проверка утверждения

Этот метод может быть переопределён для реализации алгоритма оценки.

Параметры

mixed $other

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

Возвращает

bool

reduce() protected 

reduce(): self

Уменьшает подвыражение, начинающееся с $this, пропуская вырожденные подвыражения, и возвращает первое дочернее ограничение, которое начинает невыводимое подвыражение.

Возвращает $this для терминальных ограничений и для операторов, которые начинают невыводимые подвыражения, или ближайшего потомка $this, который начинает невыводимое подвыражение.

Выражение ограничения можно смоделировать как дерево с нетерминальными узлами (операторы) и терминальными узлами. Например:

LogicalOr (оператор, нетерминал)

  • LogicalAnd (оператор, нетерминал) | + IsType('int') (терминал) | + GreaterThan(10) (терминал)
  • LogicalNot (оператор, нетерминал)
    • IsType('array') (терминал)

Вырожденное подвыражение — это часть дерева, которая фактически не вносит вклад в вычисление выражения, в котором она появляется. Примером вырожденного подвыражения является BinaryOperator, построенный с одним операндом или вложенными BinaryOperators, каждый с одним операндом. Выражение, включающее вырожденное подвыражение, эквивалентно сокращенному выражению с удаленным вырожденным подвыражением, например

LogicalAnd (оператор)

  • LogicalOr (вырожденный оператор) | + LogicalAnd (вырожденный оператор) | + IsType('int') (терминал)
  • GreaterThan(10) (терминал)

эквивалентно

LogicalAnd (оператор)

  • IsType('int') (терминал)
  • GreaterThan(10) (терминал)

потому что подвыражение

  • LogicalOr
    • LogicalAnd
      • -

является вырожденным. Вызов reduce() для объекта LogicalOr, а также LogicalAnd, вернёт экземпляр IsType('int').

Можно реализовать и другие специфические сокращения, например, каскад операторов LogicalNot

  • LogicalNot
    • LogicalNot +LogicalNot
      • IsTrue

может быть сокращено до

LogicalNot

  • IsTrue

Возвращает

self

toString() public 

toString(): string

Сообщение утверждения

Возвращает

string

toStringInContext() protected 

toStringInContext(Operator $operator, mixed $role): string

Возвращает настраиваемое строковое представление объекта ограничения, когда он появляется в контексте выражения $operator.

Цель этого метода — предоставить осмысленную описательную строку в контексте операторов, таких как LogicalNot. Стандартные ограничения PHPUnit поддерживаются из коробки LogicalNot, но внешне разработанные не имели способа предоставить правильные строки в этом контексте.

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

Параметры

Operator $operator

оператор выражения

mixed $role

роль ограничения $this в выражении $operator

Возвращает

string

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

$_validCiphers protected

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

Тип

string[]

$cookieName protected

Тип

string

$key protected

Тип

string

$mode protected

Тип

string

$response protected

Тип

Cake\Http\Response

© 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.2/class-Cake.TestSuite.Constraint.Response.CookieEncryptedEquals.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API