跳到内容

DivisibleBy

编辑此页

验证一个值是否可以被另一个值整除,该值在选项中定义。

参见

如果您需要验证集合中元素的数量可以被某个数字整除,请使用 Count 约束和 divisibleBy 选项。

基本用法

以下约束确保

  • Itemweight0.25 的增量提供
  • Itemquantity 必须可以被 5 整除
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// src/Entity/Item.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Item
{
    #[Assert\DivisibleBy(0.25)]
    protected float $weight;

    #[Assert\DivisibleBy(
        value: 5,
    )]
    protected int $quantity;
}

选项

groups

类型: array | string 默认值: null

它定义了此约束的验证组。阅读更多关于 验证组 的信息。

message

类型: string 默认值: 该值应该是 {{ compared_value }} 的倍数。

如果该值不能被比较值整除,将显示此消息。

payload

类型: mixed 默认值: null

此选项可用于将任意特定于域的数据附加到约束。配置的有效负载不由 Validator 组件使用,但其处理完全取决于您。

例如,您可能想要使用几个错误级别,以便根据错误严重性在前端以不同的方式呈现失败的约束。

propertyPath

类型: string 默认值: null

它定义了对象属性,其值用于进行比较。

例如,如果您想比较某个对象的 $endDate 属性与同一对象的 $startDate 属性,请在 $endDate 的比较约束中使用 propertyPath="startDate"

提示

当使用此选项时,其值在错误消息中作为 {{ compared_value_path }} 占位符提供。 虽然不打算将其包含在向最终用户显示的错误消息中,但在使用 API 对客户端执行任何映射逻辑时,它很有用。

value

类型: mixed [默认选项]

此选项是必需的。 它定义了比较值。 它可以是字符串、数字或对象。

这项工作,包括代码示例,根据 Creative Commons BY-SA 3.0 许可协议获得许可。
目录
    版本