Spec-Zone.ru › CakePHP 4.4

Trait CookieCryptTrait

Трейт Cookie Crypt.

Обеспечивает логику шифрования/дешифрования для компонента CookieComponent.

Пространство имён: Cake\Utility
Ссылка: https://book.cakephp.org/4/ru/controllers/components/cookie.html

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

  • $_validCiphers protected
    array<string>

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

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

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

  • _getCookieEncryptionKey() abstract protected

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

  • _implode() protected

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

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

_checkCipher() protected

_checkCipher(string $encrypt): void

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

Параметры

string $encrypt

Имя шифра.

Возвращает

void

Исключения

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

_decode() protected

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

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

Параметры

string $value

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

string|false $encrypt

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

string|null $key

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

Возвращает

array|string

_decrypt() protected

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

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

Параметры

array<string>|string $values

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

string|false $mode

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

string|null $key optional

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

Возвращает

array|string

_encrypt() protected

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

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

Параметры

array|string $value

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

string|false $encrypt

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

string|null $key optional

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

Возвращает

string

_explode() protected

_explode(string $string): array|string

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

Параметры

string $string

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

Возвращает

array|string

_getCookieEncryptionKey() abstract protected

_getCookieEncryptionKey(): string

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

Возвращает

string

_implode() protected

_implode(array $array): string

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

Параметры

array $array

Мапа ключей и значений.

Возвращает

string

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

$_validCiphers protected

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

Тип

array<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.Utility.CookieCryptTrait.html

Spec-Zone.ru

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