类 MailSentWith
MailSentWith
方法摘要
-
__construct() public
构造函数
-
additionalFailureDescription() protected
返回需要时额外的失败描述。
-
count() public
计算约束元素的数量。
-
evaluate() public
针对参数 $other 评估约束。
-
fail() protected
针对给定的比较值和测试描述抛出异常。
-
failureDescription() protected
返回失败的描述。
-
failureDescriptionInContext() protected
返回此约束出现在 $operator 表达式上下文中的失败描述。
-
getMessages() public
获取要检查的电子邮件或电子邮件
-
matches() public
检查约束
-
reduce() protected
从 $this 开始,跳过退化的子表达式,并返回第一个开始非可还原子表达式的后代约束。
-
toString() public
断言消息字符串
-
toStringInContext() protected
返回约束对象出现在 $operator 表达式上下文中的自定义字符串表示形式。
-
valueToTypeStringFragment() protected
方法详情
__construct() ¶ public
__construct(int|null $at = null, string|null $method = null): void
构造函数
参数
-
int|null
$at 可选 At
-
string|null
$method 可选 方法
返回
void
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
返回失败的描述。
大多数情况下,失败消息的开头是“断言失败”。此方法应返回该句子的第二部分。
要提供额外的失败信息,可以使用 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
getMessages() ¶ public
getMessages(): arrayCake\Mailer\Message>
获取要检查的电子邮件或电子邮件
返回
arrayCake\Mailer\Message>
reduce() ¶ 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 对象以及 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
返回
非空字符串