类 MailSentFrom
MailSentFromConstraint
方法摘要
-
__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 optional 在
-
string|null$method optional 方法
返回值
voidadditionalFailureDescription() ¶ protected
additionalFailureDescription(mixed $other): string在需要时返回额外的失败描述。
该函数可以被覆盖以提供额外的失败信息，例如差异
参数
-
mixed$other
返回值
stringevaluate() ¶ 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
返回值
never抛出
ExpectationFailedExceptionfailureDescription() ¶ protected
failureDescription(mixed $other): string返回失败的描述。
在大多数情况下，失败消息的开头是“断言失败”。此方法应返回该句子的第二部分。
要提供额外的失败信息，可以使用 additionalFailureDescription。
参数
-
mixed$other
返回值
stringfailureDescriptionInContext() ¶ protected
failureDescriptionInContext(Operator $operator, mixed $role, mixed $other): string当此约束出现在 $operator 表达式的上下文中时，返回失败的描述。
此方法的目的是在诸如 LogicalNot 之类的运算符的上下文中提供有意义的失败描述。原生 PHPUnit 约束由 LogicalNot 开箱即用地支持，但外部开发的约束无法在此上下文中提供正确的消息。
当该方法本身不处理自定义时，该方法应返回空字符串。
参数
-
Operator$operator -
mixed$role -
mixed$other
返回值
stringgetMessages() ¶ public
getMessages(): arrayCake\Mailer\Message>获取要检查的电子邮件或电子邮件
返回值
arrayCake\Mailer\Message>reduce() ¶ protected
reduce(): self通过跳过退化子表达式来减少从 $this 开始的子表达式，并返回第一个开始非可约子表达式的后代约束。
对于终端约束以及开始非可约子表达式的运算符，返回 $this，或者返回 $this 的最近后代，该后代开始非可约子表达式。
约束表达式可以建模为一棵树，其中包含非终端节点（运算符）和终端节点。例如
LogicalOr（运算符，非终端）
- LogicalAnd（运算符，非终端） | + IsType('int')（终端） | + GreaterThan(10)（终端）
- LogicalNot（运算符，非终端）
- IsType('array')（终端）
退化子表达式是树的一部分，它实际上没有对它所出现的表达式的评估做出贡献。退化子表达式的一个示例是由单个操作数或嵌套的二元运算符（每个运算符只有一个操作数）构造的二元运算符。包含退化子表达式的表达式等同于删除了退化子表达式的简化表达式，例如
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
返回值
selftoStringInContext() ¶ protected
toStringInContext(Operator $operator, mixed $role): string当约束出现在 $operator 表达式的上下文中时，返回约束对象的自定义字符串表示。
此方法的目的是在诸如 LogicalNot 之类的运算符的上下文中提供有意义的描述性字符串。原生 PHPUnit 约束由 LogicalNot 开箱即用地支持，但外部开发的约束无法在此上下文中提供正确的字符串。
当该方法本身不处理自定义时，该方法应返回空字符串。
参数
-
Operator$operator -
mixed$role
返回值
stringvalueToTypeStringFragment() ¶ protected
valueToTypeStringFragment(mixed $value): non-empty-string参数
-
mixed$value
返回值
非空字符串