EqualTo
验证一个值是否等于另一个值,该值在选项中定义。要强制值不相等,请参阅NotEqualTo。
警告
此约束使用 ==
进行比较,因此 3
和 "3"
被认为是相等的。使用 IdenticalTo 以使用 ===
进行比较。
适用于 | 属性或方法 |
类 | EqualTo |
验证器 | EqualToValidator |
基本用法
如果您想确保 Person
类的 firstName
等于 Mary
并且 age
为 20
,您可以执行以下操作
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// src/Entity/Person.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Person
{
#[Assert\EqualTo('Mary')]
protected string $firstName;
#[Assert\EqualTo(
value: 20,
)]
protected int $age;
}
选项
message
类型: string
默认值: 此值应等于 {{ compared_value }}.
这是当值不相等时将显示的消息。
您可以在此消息中使用以下参数
参数 | 描述 |
---|---|
{{ compared_value }} |
期望值 |
{{ compared_value_type }} |
期望值类型 |
{{ value }} |
当前(无效)值 |
payload
类型: mixed
默认值: null
此选项可用于将任意特定于域的数据附加到约束。配置的有效负载不被 Validator 组件使用,但其处理完全取决于您。
例如,您可能想要使用多个错误级别,以便根据错误严重程度在前端以不同方式呈现失败的约束。
propertyPath
类型: string
默认值: null
它定义了对象属性,其值用于进行比较。
例如,如果您想将某个对象的 $endDate
属性与同一对象的 $startDate
属性进行比较,请在 $endDate
的比较约束中使用 propertyPath="startDate"
。
提示
当使用此选项时,其值在错误消息中作为 {{ compared_value_path }}
占位符可用。虽然不打算将其包含在向最终用户显示的错误消息中,但在使用 API 对客户端进行任何映射逻辑时,它很有用。
这项工作,包括代码示例,根据 Creative Commons BY-SA 3.0 许可协议获得许可。