类 状态正常
状态正常
方法摘要
-
__construct() public
构造函数
-
_getBodyAsString() protected
获取响应正文作为字符串
-
additionalFailureDescription() protected
在需要时返回额外的失败描述。
-
count() public
计算约束元素的数量。
-
evaluate() public
针对参数 $other 评估约束。
-
fail() protected
针对给定的比较值和测试描述抛出异常。
-
failureDescription() protected
覆盖描述,以便我们能够删除自动的 "expected" 消息
-
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 响应
additionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): string
在需要时返回额外的失败描述。
该函数可以被覆盖以提供额外的失败信息,例如差异
参数
-
mixed
$other
返回值
string
evaluate() ¶ 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
抛出
ExpectationFailedException
fail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never
针对给定的比较值和测试描述抛出异常。
参数
-
mixed
$other -
string
$description -
?ComparisonFailure
$comparisonFailure optional
返回值
never
抛出
ExpectationFailedException
failureDescription() ¶ protected
failureDescription(mixed $other): string
覆盖描述,以便我们能够删除自动的 "expected" 消息
失败消息的开头通常是 "Failed asserting that"。此方法应返回该句子的第二部分。
为了提供额外的失败信息,可以使用 additionalFailureDescription
参数
-
mixed
$other 值
返回值
string
failureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string
返回当此约束出现在 $operator 表达式的上下文中时的失败描述。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的失败描述。LogicalNot 原生支持 PHPUnit 约束,但外部开发的约束在该上下文中无法提供正确的消息。
当该方法不自行处理自定义时,应返回空字符串。
参数
-
Operator
$operator -
mixed
$role -
mixed
$other
返回值
string
matches() ¶ public
matches(array<int, int>|int $other): bool
检查断言
此方法可以被覆盖以实现评估算法。
参数
-
array<int, int>|int
$other 最小/最大状态码数组,或单个代码
返回值
bool
readCookie() ¶ protected
readCookie(string $name): array|null
从响应 cookie 集合或标头中读取 cookie
参数
-
string
$name 要读取的 cookie 的名称。
返回值
array|null
reduce() ¶ protected
reduce(): self
通过跳过退化子表达式,减少从 $this 开始的子表达式,并返回开始非可减少子表达式的第一个后代约束。
对于终止约束以及开始非可减少子表达式的运算符,返回 $this,或者返回 $this 的最接近的后代,该后代开始非可减少子表达式。
约束表达式可以被建模为一棵树,树中包含非终端节点(运算符)和终端节点。例如
LogicalOr(运算符,非终端)
- LogicalAnd(运算符,非终端) | + IsType('int')(终端) | + GreaterThan(10)(终端)
- LogicalNot(运算符,非终端)
- IsType('array')(终端)
退化子表达式是树的一部分,它实际上对它所出现的表达式的评估没有贡献。退化子表达式的例子是使用单个操作数构造的 BinaryOperator 或嵌套的 BinaryOperator,每个 BinaryOperator 都使用单个操作数。包含退化子表达式的表达式等同于删除了退化子表达式的简化表达式,例如
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
返回值
self
statusCodeBetween() ¶ protected
statusCodeBetween(int $min, int $max): bool
用于检查状态码的帮助器
参数
-
int
$min 最小状态码(包含)
-
int
$max 最大状态码(包含)
返回值
bool
toStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): string
当约束出现在 $operator 表达式的上下文中时,返回约束对象的自定义字符串表示形式。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的描述性字符串。LogicalNot 原生支持 PHPUnit 约束,但外部开发的约束在该上下文中无法提供正确的字符串。
当该方法不自行处理自定义时,应返回空字符串。
参数
-
Operator
$operator -
mixed
$role
返回值
string
valueToTypeStringFragment() ¶ protected
valueToTypeStringFragment(mixed $value): non-empty-string
参数
-
mixed
$value
返回值
非空字符串