Spec-Zone.ru › CakePHP 3.4

Трейт CookieCryptTrait

Трейт шифрования куки.

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

Прямые пользователи

  • Cake\Controller\Component\CookieComponent
  • Cake\Http\Middleware\EncryptedCookieMiddleware
  • Cake\TestSuite\IntegrationTestCase
Пространство имён: Cake\Utility
Ссылка: https://book.cakephp.org/3.0/ru/controllers/components/cookie.html
Расположение: Utility/CookieCryptTrait.php

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

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

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

  • _checkCipher() protected
    Вспомогательный метод для проверки имён шифров.
  • _decode() protected
    Декодирует и расшифровывает одно значение.
  • _decrypt() protected
    Расшифровывает $value, используя метод public $type в классе Security.
  • _encrypt() protected
    Шифрует $value, используя метод public $type в классе Security.
  • _explode() protected

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

  • _getCookieEncryptionKey() abstract protected
    Возвращает ключ шифрования.
  • _implode() protected
    Метод implode для сохранения ключей в многомерных массивах

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

_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 optional null
Используется в качестве соли безопасности, если указан.

Возвращает

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

_encrypt()source protected

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

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

Параметры

строка $value
Значение для шифрования.
строка|логическое $encrypt

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

строка|null $key optional null
Используется в качестве соли безопасности, если указан.

Возвращает

строка
Кодированные значения

_explode()source protected

_explode( string $string )

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

Параметры

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

Возвращает

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

_getCookieEncryptionKey()source abstract protected

_getCookieEncryptionKey( )

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

Возвращает

строка

_implode()source protected

_implode( array $array )

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

Параметры

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

Возвращает

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

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

$_validCipherssource

protected массив

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

['aes', 'rijndael']

© 2005–2017 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/3.4/class-Cake.Utility.CookieCryptTrait.html

Spec-Zone.ru

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