类 EventFiredWith
EventFiredWith 约束
属性摘要
-
$_dataKey protected
字符串事件数据键
-
$_dataValue protected
混合事件数据值
-
$_eventManager protected
Cake\Event\EventManager已触发事件的数组
方法摘要
-
__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
方法详情
__construct() ¶ public
__construct(Cake\Event\EventManager $eventManager, string $dataKey, mixed $dataValue)构造函数
参数
-
Cake\Event\EventManager$eventManager 要检查的事件管理器
-
string$dataKey 数据键
-
mixed$dataValue 数据值
additionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): string在需要时返回额外的故障描述。
该函数可以被覆盖以提供额外的故障信息，例如差异
参数
-
mixed$other
返回
字符串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抛出
ExpectationFailedExceptionfail() ¶ protected
fail(mixed $other, string $description, ?ComparisonFailure $comparisonFailure = null): never针对给定比较值和测试描述抛出异常。
参数
-
mixed$other -
string$description -
?ComparisonFailure$comparisonFailure optional
返回
从不抛出
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): string返回故障描述。
故障消息的开头在大多数情况下是“断言失败”。此方法应返回该句子的第二部分。
要提供额外的故障信息，可以使用 additionalFailureDescription。
参数
-
mixed$other
返回
字符串failureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string当此约束出现在 $operator 表达式的上下文中时，返回故障描述。
此方法的目的是在诸如 LogicalNot 之类的运算符的上下文中提供有意义的故障描述。原生 PHPUnit 约束通过 LogicalNot 开箱即用，但外部开发的约束无法在此上下文中提供正确的消息。
如果此方法没有自行处理自定义，则应返回空字符串。
参数
-
Operator$operator -
mixed$role -
mixed$other
返回
字符串matches() ¶ public
matches(mixed $other): bool检查事件是否在已触发数组中
此方法可以被覆盖以实现评估算法。
参数
-
mixed$other 约束检查
返回
布尔值抛出
PHPUnit\Framework\AssertionFailedErrorreduce() ¶ protected
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
返回
selftoStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): string当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示形式。
此方法的目的是在诸如 LogicalNot 之类的运算符的上下文中提供有意义的描述性字符串。原生 PHPUnit 约束通过 LogicalNot 开箱即用，但外部开发的约束无法在此上下文中提供正确的字符串。
如果此方法没有自行处理自定义，则应返回空字符串。
参数
-
Operator$operator -
mixed$role
返回
字符串valueToTypeStringFragment() ¶ protected
valueToTypeStringFragment(mixed $value): non-empty-string参数
-
mixed$value
返回
非空字符串