W3cubDocs

/CakePHP 4.1

Class CookieEncryptedEquals

CookieEncryptedEquals

Properties summary

Method Summary

  • __construct() public

    Constructor.

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

  • _getBodyAsString() protected

    Get the response body as string

  • _getCookieEncryptionKey() protected

    Returns the encryption key

  • _implode() protected

    Implode method to keep keys are multidimensional arrays

  • additionalFailureDescription() protected

    Return additional failure description where needed

  • count() public

    Counts the number of constraint elements.

  • evaluate() public

    Evaluates the constraint for parameter $other

  • exporter() protected
  • fail() protected

    Throws an exception for the given compared value and test description

  • failureDescription() protected

    Returns the description of the failure

  • matches() public

    Checks assertion

  • toString() public

    Assertion message

Method Detail

__construct() public

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

Constructor.

Parameters

\Cake\Http\Response|null $response

A response instance.

string $cookieName

Cookie name

string $mode

Mode

string $key

Key

_checkCipher() protected

_checkCipher(string $encrypt)

Helper method for validating encryption cipher names.

Parameters

string $encrypt

The cipher name.

Throws

RuntimeException
When an invalid cipher is provided.

_decode() protected

_decode(string $value, mixed $encrypt, ?string $key)

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

string|array

Decoded values.

_decrypt() protected

_decrypt(mixed $values, mixed $mode, ?string $key)

Decrypts $value using public $type method in Security class

Parameters

string[]|string $values

Values to decrypt

string|false $mode

Encryption mode

string|null $key optional

Used as the security salt if specified.

Returns

string|array

Decrypted values

_encrypt() protected

_encrypt(mixed $value, mixed $encrypt, ?string $key)

Encrypts $value using public $type method in Security class

Parameters

string|array $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

Encoded values

_explode() protected

_explode(string $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

string|array

Map of key and values

_getBodyAsString() protected

_getBodyAsString()

Get the response body as string

Returns

string

The response body.

_getCookieEncryptionKey() protected

_getCookieEncryptionKey()

Returns the encryption key

Returns

string

_implode() protected

_implode(array $array)

Implode method to keep keys are multidimensional arrays

Parameters

array $array

Map of key and values

Returns

string

A JSON encoded string.

additionalFailureDescription() protected

additionalFailureDescription(mixed $other)

Return additional failure description where needed

The function can be overridden to provide additional failure information like a diff

Parameters

mixed $other

evaluated value or object

count() public

count()

Counts the number of constraint elements.

evaluate() public

evaluate(mixed $other, string $description, bool $returnResult)

Evaluates the constraint for parameter $other

If $returnResult is set to false (the default), an exception is thrown in case of a failure. null is returned otherwise.

If $returnResult is true, the result of the evaluation is returned as a boolean value instead: true in case of success, false in case of a failure.

Parameters

mixed $other
string $description optional
bool $returnResult optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

exporter() protected

exporter()

fail() protected

fail(mixed $other, mixed $description, \SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure)

Throws an exception for the given compared value and test description

Parameters

mixed $other

evaluated value or object

string $description

Additional information about the test

\SebastianBergmann\Comparator\ComparisonFailure $comparisonFailure optional

Throws

PHPUnit\Framework\ExpectationFailedException

SebastianBergmann\RecursionContext\InvalidArgumentException

failureDescription() protected

failureDescription(mixed $other)

Returns the description of the failure

The beginning of failure messages is "Failed asserting that" in most cases. This method should return the second part of that sentence.

To provide additional failure information additionalFailureDescription can be used.

Parameters

mixed $other

evaluated value or object

Throws

SebastianBergmann\RecursionContext\InvalidArgumentException

matches() public

matches(mixed $other)

Checks assertion

Parameters

mixed $other

Expected content

Returns

bool

toString() public

toString()

Assertion message

Returns

string

Property Detail

$_validCiphers protected

Valid cipher names for encrypted cookies.

Type

string[]

$cookieName protected

Type

string

$key protected

Type

string

$mode protected

Type

string

$response protected

Type

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