类 ResponseBase
响应约束的基类约束
属性概要
-
$response 受保护
Psr\Http\Message\ResponseInterface
方法概要
-
__construct() 公有
构造函数
-
_getBodyAsString() 受保护
获取响应主体作为字符串
-
additionalFailureDescription() 受保护
在需要时返回额外的失败描述。
-
count() 公有
计算约束元素的数量。
-
evaluate() 公有
评估参数 $other 的约束。
-
fail() 受保护
针对给定的比较值和测试描述抛出异常。
-
failureDescription() 受保护
返回失败的描述。
-
failureDescriptionInContext() 受保护
当此约束出现在 $operator 表达式的上下文中时，返回失败的描述。
-
matches() 受保护
评估参数 $other 的约束。如果约束满足，则返回 true，否则返回 false。
-
readCookie() 受保护
从响应 cookie 集合或标头中读取 cookie
-
reduce() 受保护
通过跳过退化子表达式来减少从 $this 开始的子表达式，并返回开始非可还原子表达式的第一个后代约束。
-
toString() 公有
返回对象的字符串表示。
-
toStringInContext() 受保护
当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示。
-
valueToTypeStringFragment() 受保护
方法详细说明
__construct() ¶ 公有
__construct(Psr\Http\Message\ResponseInterface|null $response)构造函数
参数
-
Psr\Http\Message\ResponseInterface|null$response Response
additionalFailureDescription() ¶ 受保护
additionalFailureDescription(mixed $other): string在需要时返回额外的失败描述。
此函数可以被覆盖以提供额外的失败信息，例如差异
参数
-
混合$other
返回值
stringevaluate() ¶ 公有
evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool评估参数 $other 的约束。
如果 $returnResult 设置为 false（默认值），则在失败的情况下会抛出异常。否则返回 null。
如果 $returnResult 为 true，则评估结果将作为布尔值返回：成功时为 true，失败时为 false。
参数
-
混合$other -
string$description 可选 -
bool$returnResult 可选
返回值
?bool抛出
ExpectationFailedExceptionfail() ¶ 受保护
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never针对给定的比较值和测试描述抛出异常。
参数
-
混合$other -
string$description -
?ComparisonFailure$comparisonFailure 可选
返回值
永不抛出
ExpectationFailedExceptionfailureDescription() ¶ 受保护
failureDescription(mixed $other): string返回失败的描述。
失败消息的开头在大多数情况下是“断言失败”。此方法应返回该句子的第二部分。
若要提供额外的失败信息，可以使用 additionalFailureDescription。
参数
-
混合$other
返回值
stringfailureDescriptionInContext() ¶ 受保护
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string当此约束出现在 $operator 表达式的上下文中时，返回失败的描述。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的失败描述。本机 PHPUnit 约束由 LogicalNot 开箱即用地支持，但外部开发的约束无法在此上下文中提供正确的消息。
当此方法本身不处理自定义时，它应返回空字符串。
参数
-
运算符$operator -
混合$role -
混合$other
返回值
stringmatches() ¶ 受保护
matches(mixed $other): bool评估参数 $other 的约束。如果约束满足，则返回 true，否则返回 false。
此方法可以被覆盖以实现评估算法。
参数
-
混合$other
返回值
boolreadCookie() ¶ 受保护
readCookie(string $name): array|null从响应 cookie 集合或标头中读取 cookie
参数
-
string$name 要读取的 cookie 的名称。
返回值
array|nullreduce() ¶ 受保护
reduce(): self通过跳过退化子表达式来减少从 $this 开始的子表达式，并返回开始非可还原子表达式的第一个后代约束。
对于终端约束和开始非可还原子表达式的运算符，返回 $this，或者返回 $this 的最近后代，该后代开始非可还原子表达式。
约束表达式可以被建模为一棵树，包含非终端节点（运算符）和终端节点。例如
LogicalOr（运算符，非终端）
- LogicalAnd（运算符，非终端） | + IsType('int')（终端） | + GreaterThan(10)（终端）
- LogicalNot（运算符，非终端）
- IsType('array')（终端）
退化子表达式是树的一部分，它实际上对它所出现的表达式的评估没有贡献。退化子表达式的一个示例是用单个操作数或嵌套的 BinaryOperators（每个操作数都只有一个操作数）构造的 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
返回值
自身toStringInContext() ¶ 受保护
toStringInContext(Operator $operator, mixed $role): string当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的描述性字符串。本机 PHPUnit 约束由 LogicalNot 开箱即用地支持，但外部开发的约束无法在此上下文中提供正确的字符串。
当此方法本身不处理自定义时，它应返回空字符串。
参数
-
运算符$operator -
混合$role
返回值
stringvalueToTypeStringFragment() ¶ 受保护
valueToTypeStringFragment(mixed $value): non-empty-string参数
-
混合$value
返回值
非空字符串