类 LayoutFileEquals
LayoutFileEquals
属性摘要
-
$filename protected
string
方法摘要
-
__construct() public
构造函数
-
additionalFailureDescription() protected
在需要时返回额外的失败描述。
-
count() public
计算约束元素的数量。
-
evaluate() public
针对参数 $other 评估约束。
-
fail() protected
针对给定的比较值和测试描述抛出异常。
-
failureDescription() protected
返回失败的描述。
-
failureDescriptionInContext() protected
当此约束出现在 $operator 表达式的上下文中时,返回失败的描述。
-
matches() public
检查断言
-
reduce() protected
通过跳过退化的子表达式,从 $this 开始减少子表达式,并返回第一个子表达式开始的非可减少子表达式的后代约束。
-
toString() public
断言信息
-
toStringInContext() protected
当约束出现在 $operator 表达式的上下文中时,返回约束对象的自定义字符串表示形式。
-
valueToTypeStringFragment() protected
方法详情
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 可选 -
bool
$returnResult 可选
返回值
?bool
抛出
ExpectationFailedException
fail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never
针对给定的比较值和测试描述抛出异常。
参数
-
mixed
$other -
string
$description -
?ComparisonFailure
$comparisonFailure 可选
返回值
永远不会
抛出
ExpectationFailedException
failureDescription() ¶ protected
failureDescription(mixed $other): string
返回失败的描述。
失败消息的开头在大多数情况下是“Failed asserting that”。此方法应返回该句子的第二部分。
要提供额外的失败信息,可以使用 additionalFailureDescription。
参数
-
mixed
$other
返回值
string
failureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string
当此约束出现在 $operator 表达式的上下文中时,返回失败的描述。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的失败描述。本机 PHPUnit 约束由 LogicalNot 开箱即用地支持,但外部开发的约束无法在该上下文中提供正确的消息。
当该方法不自行处理自定义时,该方法应返回空字符串。
参数
-
Operator
$operator -
mixed
$role -
mixed
$other
返回值
string
matches() ¶ public
matches(mixed $other): bool
检查断言
此方法可以被覆盖以实现评估算法。
参数
-
mixed
$other 预期的文件名
返回值
bool
reduce() ¶ 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 对象上调用 reduce(),以及在 LogicalAnd 上调用 reduce(),都将返回 IsType('int') 实例。
可以实现其他特定的减少,例如 LogicalNot 运算符的级联
- LogicalNot
- LogicalNot +LogicalNot
- IsTrue
- LogicalNot +LogicalNot
可以简化为
LogicalNot
- IsTrue
返回值
self
toStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): string
当约束出现在 $operator 表达式的上下文中时,返回约束对象的自定义字符串表示形式。
此方法的目的是在 LogicalNot 等运算符的上下文中提供有意义的描述性字符串。本机 PHPUnit 约束由 LogicalNot 开箱即用地支持,但外部开发的约束无法在该上下文中提供正确的字符串。
当该方法不自行处理自定义时,该方法应返回空字符串。
参数
-
Operator
$operator -
mixed
$role
返回值
string
valueToTypeStringFragment() ¶ protected
valueToTypeStringFragment(mixed $value): non-empty-string
参数
-
mixed
$value
返回值
非空字符串