类 ContentsNotContain
ContentsNotContain
方法摘要
-
__construct() 公共
构造函数
-
additionalFailureDescription() 受保护
在需要时返回额外的失败描述。
-
count() 公共
统计约束元素的数量。
-
evaluate() 公共
针对参数 $other 评估约束。
-
fail() 受保护
针对给定的比较值和测试描述抛出异常。
-
failureDescription() 受保护
返回失败的描述。
-
failureDescriptionInContext() 受保护
当此约束出现在 $operator 表达式的上下文中时,返回失败的描述。
-
matches() 公共
检查内容是否包含预期内容
-
reduce() 受保护
通过跳过退化的子表达式来减少从 $this 开始的子表达式,并返回第一个开始非可减少子表达式的后代约束。
-
toString() 公共
断言消息
-
toStringInContext() 受保护
当约束出现在 $operator 表达式的上下文中时,返回约束对象的自定义字符串表示形式。
-
valueToTypeStringFragment() 受保护
方法详情
__construct() ¶ 公共
__construct(list<string> $contents, string $output)
构造函数
参数
-
list<string>
$contents 内容
-
string
$output 输出类型
additionalFailureDescription() ¶ 受保护
additionalFailureDescription(mixed $other): string
在需要时返回额外的失败描述。
该函数可以被覆盖以提供额外的失败信息,例如差异
参数
-
mixed
$other
返回
字符串
evaluate() ¶ 公共
evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool
针对参数 $other 评估约束。
如果 $returnResult 设置为 false(默认值),则在发生失败的情况下会抛出异常。否则返回 null。
如果 $returnResult 设置为 true,则评估结果将作为布尔值返回:成功则为 true,失败则为 false。
参数
-
mixed
$other -
string
$description 可选 -
bool
$returnResult 可选
返回
?bool
抛出
ExpectationFailedException
fail() ¶ 受保护
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never
针对给定的比较值和测试描述抛出异常。
参数
-
mixed
$other -
string
$description -
?ComparisonFailure
$comparisonFailure 可选
返回
永不
抛出
ExpectationFailedException
failureDescription() ¶ 受保护
failureDescription(mixed $other): string
返回失败的描述。
在大多数情况下,失败消息的开头是“断言失败”。此方法应返回该句子的第二部分。
要提供额外的失败信息,可以使用 additionalFailureDescription。
参数
-
mixed
$other
返回
字符串
failureDescriptionInContext() ¶ 受保护
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string
当此约束出现在 $operator 表达式的上下文中时,返回失败的描述。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的失败描述。原生 PHPUnit 约束由 LogicalNot 开箱即用地支持,但外部开发的约束无法在此上下文中提供正确的消息。
如果该方法本身不处理自定义,则应返回空字符串。
参数
-
Operator
$operator -
mixed
$role -
mixed
$other
返回
字符串
reduce() ¶ 受保护
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 对象以及 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
$operator -
mixed
$role
返回
字符串
valueToTypeStringFragment() ¶ 受保护
valueToTypeStringFragment(mixed $value): non-empty-string
参数
-
mixed
$value
返回
非空字符串