CookieEncryptedEquals 类
CookieEncryptedEquals
属性摘要
-
$_validCiphers protected
list<string>加密 Cookie 的有效密码名称。
-
$cookieName protected
string -
$key protected
string -
$mode protected
string -
$response protected
Cake\Http\Response
方法摘要
-
__construct() public
构造函数。
-
_checkCipher() protected
验证加密密码名称的辅助方法。
-
_decode() protected
解码和解密单个值。
-
_decrypt() protected
使用 Security 类中的公共 $type 方法解密 $value。
-
_encrypt() protected
使用 Security 类中的公共 $type 方法加密 $value。
-
_explode() protected
explode 方法用于从 CookieComponent::_implode() 中设置的字符串返回数组。保持与 1.x CookieComponent::_implode() 向后兼容。
-
_getBodyAsString() protected
获取响应主体作为字符串。
-
_getCookieEncryptionKey() protected
返回加密密钥。
-
_implode() protected
implode 方法用于保留多维数组的键。
-
additionalFailureDescription() protected
在需要时返回额外的失败描述。
-
count() public
计算约束元素的数量。
-
evaluate() public
针对参数 $other 评估约束。
-
fail() protected
针对给定的比较值和测试描述抛出异常。
-
failureDescription() protected
返回失败的描述。
-
failureDescriptionInContext() protected
当此约束出现在 $operator 表达式的上下文中时，返回失败的描述。
-
matches() public
检查断言。
-
readCookie() protected
从响应 cookie 集合或标头读取 cookie。
-
reduce() protected
通过跳过退化子表达式来减少从 $this 开始的子表达式，并返回开始非可约子表达式的第一个后代约束。
-
toString() public
断言消息。
-
toStringInContext() protected
当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示形式。
-
valueToTypeStringFragment() protected
方法详情
__construct() ¶ public
__construct(Cake\Http\Response|null $response, string $cookieName, string $mode, string $key)构造函数。
参数
-
Cake\Http\Response|null$response 响应实例。
-
string$cookieName Cookie 名称。
-
string$mode 模式。
-
string$key 密钥。
_checkCipher() ¶ protected
_checkCipher(string $encrypt): void验证加密密码名称的辅助方法。
参数
-
string$encrypt 密码名称。
返回值
void抛出
RuntimeException当提供无效密码时。
_decode() ¶ protected
_decode(string $value, string|false $encrypt, string|null $key): array|string解码和解密单个值。
参数
-
string$value 要解码和解密的值。
-
string|false$encrypt 要使用的加密密码。
-
string|null$key 如果指定，用作安全盐。
返回值
array|string_decrypt() ¶ protected
_decrypt(list<string>|string $values, string|false $mode, string|null $key = null): array|string使用 Security 类中的公共 $type 方法解密 $value。
参数
-
list<string>|string$values 要解密的值。
-
string|false$mode 加密模式。
-
string|null$key optional 如果指定，用作安全盐。
返回值
array|string_encrypt() ¶ protected
_encrypt(array|string $value, string|false $encrypt, string|null $key = null): string使用 Security 类中的公共 $type 方法加密 $value。
参数
-
array|string$value 要加密的值。
-
string|false$encrypt 要使用的加密模式。False 禁用加密。
-
string|null$key optional 如果指定，用作安全盐。
返回值
string_explode() ¶ protected
_explode(string $string): array|stringexplode 方法用于从 CookieComponent::_implode() 中设置的字符串返回数组。保持与 1.x CookieComponent::_implode() 向后兼容。
参数
-
string$string 包含 JSON 编码数据的字符串，或一个裸字符串。
返回值
array|string_implode() ¶ protected
_implode(array $array): stringimplode 方法用于保留多维数组的键。
参数
-
array$array 键值映射。
返回值
stringadditionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): string在需要时返回额外的失败描述。
该函数可以被重写以提供额外的失败信息，如 diff。
参数
-
mixed$other
返回值
stringevaluate() ¶ public
evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool针对参数 $other 评估约束。
如果 $returnResult 设置为 false（默认值），则在失败的情况下会抛出异常。否则返回 null。
如果 $returnResult 为 true，则返回评估结果的布尔值：成功则为 true，失败则为 false。
参数
-
mixed$other -
string$description optional -
bool$returnResult optional
返回值
?bool抛出
ExpectationFailedExceptionfail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never针对给定的比较值和测试描述抛出异常。
参数
-
mixed$other -
string$description -
?ComparisonFailure$comparisonFailure optional
返回值
never抛出
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): string返回失败的描述。
失败消息的开头在大多数情况下是“Failed asserting that”。此方法应返回该句子的第二部分。
要提供额外的失败信息，可以使用 additionalFailureDescription。
参数
-
mixed$other
返回值
stringfailureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string当此约束出现在 $operator 表达式的上下文中时，返回失败的描述。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的失败描述。本机 PHPUnit 约束由 LogicalNot 原生支持，但外部开发的约束无法在这种上下文中提供正确的消息。
当该方法本身不处理自定义时，它应返回空字符串。
参数
-
Operator$operator -
mixed$role -
mixed$other
返回值
stringreadCookie() ¶ protected
readCookie(string $name): array|null从响应 cookie 集合或标头读取 cookie。
参数
-
string$name 要读取的 Cookie 的名称。
返回值
array|nullreduce() ¶ protected
reduce(): self通过跳过退化子表达式来减少从 $this 开始的子表达式，并返回开始非可约子表达式的第一个后代约束。
对于终端约束和从非可简化子表达式开始的操作符，返回 $this；或者返回 $this 的最近子代，该子代从非可简化子表达式开始。
约束表达式可以被建模为一棵树，树中包含非终端节点（操作符）和终端节点。例如
LogicalOr（操作符，非终端）
- LogicalAnd（操作符，非终端） | + IsType('int')（终端） | + GreaterThan(10)（终端）
- LogicalNot（操作符，非终端）
- IsType('array')（终端）
退化子表达式是树的一部分，它实际上不会对它所出现的表达式的求值做出贡献。退化子表达式的示例是使用单个操作数或嵌套的二元操作符（每个操作符都具有单个操作数）构造的 BinaryOperator。包含退化子表达式的表达式等同于删除退化子表达式后的简化表达式，例如
LogicalAnd（操作符）
- LogicalOr（退化操作符） | + LogicalAnd（退化操作符） | + IsType('int')（终端）
- GreaterThan(10)（终端）
等同于
LogicalAnd（操作符）
- IsType('int')（终端）
- GreaterThan(10)（终端）
因为子表达式
- LogicalOr
- LogicalAnd
- -
- LogicalAnd
是退化的。在上面的 LogicalOr 对象以及 LogicalAnd 上调用 reduce()，将返回 IsType('int') 实例。
可以实现其他特定的简化，例如 LogicalNot 操作符的级联
- LogicalNot
- LogicalNot +LogicalNot
- IsTrue
- LogicalNot +LogicalNot
可以简化为
LogicalNot
- IsTrue
返回值
selftoStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): string当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示形式。
此方法的目的是在 LogicalNot 等操作符的上下文中提供有意义的描述性字符串。原生 PHPUnit 约束由 LogicalNot 开箱即用地支持，但外部开发的约束无法在该上下文中提供正确的字符串。
当该方法本身不处理自定义时，它应返回空字符串。
参数
-
Operator$operator -
mixed$role
返回值
stringvalueToTypeStringFragment() ¶ protected
valueToTypeStringFragment(mixed $value): non-empty-string参数
-
mixed$value
返回值
非空字符串