Трейт CookieCryptTrait
Трейт Cookie Crypt.
Предоставляет логику шифрования/дешифрования для компонента CookieComponent.
Прямые пользователи
- Cake\Controller\Component\CookieComponent
- Cake\Http\Middleware\EncryptedCookieMiddleware
- Cake\TestSuite\IntegrationTestCase
Ссылка: https://book.cakephp.org/3.0/ru/controllers/components/cookie.html
Расположение: Utility/CookieCryptTrait.php
Краткое описание свойств
-
$_validCiphersprotectedДопустимые имена шифров для зашифрованных файлов cookie.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().
- Возвращает ключ шифрования, который будет использоваться.
- _implode() protectedМетод implode для сохранения ключей в многомерных массивах
Подробное описание методов
_checkCipher()source protected
_checkCipher( string $encrypt )
Вспомогательный метод для проверки имен шифров шифрования.
Параметры
- string
$encrypt - Имя шифра.
Исключения
RuntimeExceptionПри предоставлении недопустимого шифра.
_decode()source protected
_decode( string $value , string|false $encrypt , string|null $key )
Декодирует и расшифровывает одно значение.
Параметры
- string
$value - Значение для декодирования и расшифрования.
- string|false
$encrypt - Используемый шифр шифрования.
- string|null
$key - Используется в качестве соли безопасности, если указано.
Возвращаемое значение
string|arrayДекодированные значения.
_decrypt()source protected
_decrypt( array $values , string|boolean $mode , string|null $key null )
Расшифровывает $value, используя метод public $type в классе Security.
Параметры
- array
$values - Значения для расшифрования
- string|boolean
$mode - Режим шифрования
- string|null
$keyoptional null - Используется в качестве соли безопасности, если указано.
Возвращаемое значение
string|arrayРасшифрованные значения
_encrypt()source protected
_encrypt( string $value , string|boolean $encrypt , string|null $key null )
Шифрует $value, используя метод public $type в классе Security.
Параметры
- string
$value - Значение для шифрования
- string|boolean
$encrypt Используемый режим шифрования. False отключает шифрование.
- string|null
$keyoptional null - Используется в качестве соли безопасности, если указано.
Возвращаемое значение
stringЗакодированные значения
_explode()source protected
_explode( string $string )
Метод explode для возврата массива из строки, установленной в CookieComponent::_implode() Поддерживает обратную совместимость с чтением из 1.x CookieComponent::_implode().
Параметры
- string
$string - Строка, содержащая данные, закодированные в JSON, или обычная строка.
Возвращаемое значение
string|arrayКарта ключей и значений
_getCookieEncryptionKey()source abstract protected
_getCookieEncryptionKey( )
Возвращает ключ шифрования, который будет использоваться.
Возвращаемое значение
string_implode()source protected
_implode( array $array )
Метод implode для сохранения ключей в многомерных массивах
Параметры
- array
$array - Карта ключей и значений
Возвращаемое значение
stringСтрока, закодированная в формате JSON.
Подробное описание свойств
$_validCipherssource
protected array
Допустимые имена шифров для зашифрованных файлов cookie.
['aes', 'rijndael']
© 2005–2018 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.5/class-Cake.Utility.CookieCryptTrait.html