类 StatusCode
StatusCode
方法摘要
-
__construct() public
构造函数
-
_getBodyAsString() protected
将响应主体作为字符串获取
-
additionalFailureDescription() protected
根据需要返回额外的失败描述。
-
count() public
计算约束元素的数量。
-
evaluate() public
评估参数 $other 的约束条件。
-
fail() protected
针对给定的比较值和测试描述抛出异常。
-
failureDescription() public
失败描述
-
failureDescriptionInContext() protected
当此约束条件出现在 $operator 表达式上下文中时，返回失败的描述。
-
matches() public
检查断言
-
readCookie() protected
从响应 cookie 集合或标头中读取 cookie
-
reduce() protected
通过跳过退化的子表达式来减少从 $this 开始的子表达式，并返回第一个从非可减少子表达式开始的后代约束条件。
-
statusCodeBetween() protected
用于检查状态码的助手
-
toString() public
断言消息
-
toStringInContext() protected
当约束对象出现在 $operator 表达式上下文中时，返回约束对象的自定字符串表示形式。
-
valueToTypeStringFragment() protected
方法详情
__construct() ¶ public
__construct(Psr\Http\Message\ResponseInterface|null $response)构造函数
参数
-
Psr\Http\Message\ResponseInterface|null$response Response
additionalFailureDescription() ¶ 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() ¶ public
failureDescription(mixed $other): string失败描述
在大多数情况下，失败消息的开头是“Failed asserting that”。此方法应该返回该句子的第二部分。
要提供额外的失败信息，可以使用 additionalFailureDescription。
参数
-
mixed$other 预期代码
返回值
stringfailureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string当此约束条件出现在 $operator 表达式上下文中时，返回失败的描述。
此方法的目的是在逻辑非等运算符的上下文中提供有意义的失败描述。原生 PHPUnit 约束在逻辑非等运算符中默认支持，但外部开发的约束条件无法在此上下文中提供正确的消息。
如果此方法不自行处理自定义，则应返回空字符串。
参数
-
Operator$operator -
mixed$role -
mixed$other
返回值
stringmatches() ¶ public
matches(array<int, int>|int $other): bool检查断言
此方法可以被重写以实现评估算法。
参数
-
array<int, int>|int$other 最小/最大状态码数组，或单个代码
返回值
boolreadCookie() ¶ 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')（终端节点）
退化的子表达式是树的一部分，它实际上对包含它的表达式的评估没有贡献。退化子表达式的示例是使用单个操作数或嵌套的二元运算符（每个二元运算符都使用单个操作数）构造的二元运算符。涉及退化子表达式的表达式等同于删除了退化子表达式的简化表达式，例如
LogicalAnd（运算符）
- LogicalOr（退化运算符） | + LogicalAnd（退化运算符） | + IsType('int')（终端节点）
- GreaterThan(10)（终端节点）
等同于
LogicalAnd（运算符）
- IsType('int')（终端节点）
- GreaterThan(10)（终端节点）
因为子表达式
- LogicalOr
- LogicalAnd
- -
- LogicalAnd
是退化的。在上面的 LogicalOr 对象上调用 reduce()，以及在 LogicalAnd 上调用 reduce()，都将返回 IsType('int') 实例。
可以实现其他具体的简化，例如 LogicalNot 运算符的级联
- LogicalNot
- LogicalNot +LogicalNot
- IsTrue
- LogicalNot +LogicalNot
可以简化为
LogicalNot
- IsTrue
返回值
selfstatusCodeBetween() ¶ protected
statusCodeBetween(int $min, int $max): bool用于检查状态码的助手
参数
-
int$min 最小状态码（包含）
-
int$max 最大状态码（包含）
返回值
booltoStringInContext() ¶ 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
返回值
非空字符串