Class CookieEncryptedEquals
CookieEncryptedEquals
Property Summary
-
$_validCiphers protected
string[]Valid cipher names for encrypted cookies.
-
$cookieName protected
string -
$exporter protected
-
$key protected
string -
$mode protected
string -
$response protected
Cake\Http\Response
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
-
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(Response $response, string $cookieName, string $mode, string $key)Constructor.
Parameters
-
Response$response Response
-
string$cookieName Cookie name
-
string$mode Mode
-
string$key Key
_checkCipher() ¶ protected
_checkCipher(string $encrypt): voidHelper method for validating encryption cipher names.
Parameters
-
string$encrypt The cipher name.
Returns
voidThrows
RuntimeExceptionWhen an invalid cipher is provided.
_decode() ¶ protected
_decode(string $value, string|false $encrypt, string|null $key): string|arrayDecodes 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_decrypt() ¶ protected
_decrypt(string[]|string $values, string|false $mode, string|null $key = null): string|arrayDecrypts $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_encrypt() ¶ protected
_encrypt(string|array $value, string|false $encrypt, string|null $key = null): stringEncrypts $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_explode() ¶ protected
_explode(string $string): string|arrayExplode 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_getBodyAsString() ¶ protected
_getBodyAsString(): stringGet the response body as string
Returns
string_getCookieEncryptionKey() ¶ protected
_getCookieEncryptionKey(): stringReturns the encryption key
Returns
string_implode() ¶ protected
_implode(array $array): stringImplode method to keep keys are multidimensional arrays
Parameters
-
array$array Map of key and values
Returns
stringadditionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): stringReturn 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.
Returns
stringevaluate() ¶ public
evaluate(mixed $other, string $description = '', bool $returnResult = false): mixedEvaluates 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 Value or object to evaluate.
-
string$description optional Additional information about the test
-
bool$returnResult optional Whether to return a result or throw an exception
Returns
mixedThrows
ExpectationFailedExceptionfail() ¶ protected
fail(mixed $other, string $description, ComparisonFailure $comparisonFailure = null)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
-
ComparisonFailure$comparisonFailure optional
Throws
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): stringReturns 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.
Returns
stringmatches() ¶ public
matches(mixed $other): boolChecks assertion
This method can be overridden to implement the evaluation algorithm.
Parameters
-
mixed$other Expected content
Returns
bool