Docs4dev
Docs
cakephp / 4.4 / trait-cake.utility.cookiecrypttrait.html

Trait CookieCryptTrait

Cookie Crypt Trait.

Provides the encrypt/decrypt logic for the CookieComponent.

Namespace: Cake\Utility
Link: https://book.cakephp.org/4/en/controllers/components/cookie.html

Property Summary

  • $_validCiphers protected
    array<string>

    Valid cipher names for encrypted cookies.

Method Summary

  • _checkCipher() protected

    Helper method for validating encryption cipher names.

  • _decode() protected

    Decodes and decrypts a single value.

  • _decrypt() protected

    Decrypts $value using public $type method in Security class

  • _encrypt() protected

    Encrypts $value using public $type method in Security class

  • _explode() protected

    Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().

  • _getCookieEncryptionKey() abstract protected

    Returns the encryption key to be used.

  • _implode() protected

    Implode method to keep keys are multidimensional arrays

Method Detail

_checkCipher() protected

_checkCipher(string $encrypt): void

Helper method for validating encryption cipher names.

Parameters

string $encrypt

The cipher name.

Returns

void

Throws

RuntimeException
When an invalid cipher is provided.

_decode() protected

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

Decodes and decrypts a single value.

Parameters

string $value

The value to decode & decrypt.

string|false $encrypt

The encryption cipher to use.

string|null $key

Used as the security salt if specified.

Returns

array|string

_decrypt() protected

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

Decrypts $value using public $type method in Security class

Parameters

array<string>|string $values

Values to decrypt

string|false $mode

Encryption mode

string|null $key optional

Used as the security salt if specified.

Returns

array|string

_encrypt() protected

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

Encrypts $value using public $type method in Security class

Parameters

array|string $value

Value to encrypt

string|false $encrypt

Encryption mode to use. False disabled encryption.

string|null $key optional

Used as the security salt if specified.

Returns

string

_explode() protected

_explode(string $string): array|string

Explode method to return array from string set in CookieComponent::_implode() Maintains reading backwards compatibility with 1.x CookieComponent::_implode().

Parameters

string $string

A string containing JSON encoded data, or a bare string.

Returns

array|string

_getCookieEncryptionKey() abstract protected

_getCookieEncryptionKey(): string

Returns the encryption key to be used.

Returns

string

_implode() protected

_implode(array $array): string

Implode method to keep keys are multidimensional arrays

Parameters

array $array

Map of key and values

Returns

string

Property Detail

$_validCiphers protected

Valid cipher names for encrypted cookies.

Type

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