Luhn

编辑此页

此约束用于确保信用卡号码通过 Luhn 算法。它作为验证信用卡的第一步非常有用：在与支付网关通信之前。

适用于	属性或方法
类	Luhn
验证器	LuhnValidator

基本用法

要使用 Luhn 验证器，请将其应用于对象上将包含信用卡号码的属性。

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/Transaction.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Transaction
{
    #[Assert\Luhn(message: 'Please check your credit card number.')]
    protected string $cardNumber;
}
    

        1
2
3
4
5
6
        # config/validator/validation.yaml
App\Entity\Transaction:
    properties:
        cardNumber:
            - Luhn:
                message: Please check your credit card number.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.ac.cn/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.ac.cn/schema/dic/constraint-mapping http://symfony.ac.cn/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Transaction">
        <property name="cardNumber">
            <constraint name="Luhn">
                <option name="message">Please check your credit card number.</option>
            </constraint>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        // src/Entity/Transaction.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Transaction
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('cardNumber', new Assert\Luhn([
            'message' => 'Please check your credit card number',
        ]));
    }
}
    

注意

与大多数其他约束一样，null 和空字符串被视为有效值。这是为了允许它们成为可选值。如果该值是强制性的，一个常见的解决方案是将此约束与 NotBlank 结合使用。

选项

`groups`

类型: array | string 默认值: null

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

`message`

类型: string 默认值: 无效的卡号。

当值未通过 Luhn 检查时提供的默认消息。

你可以在此消息中使用以下参数

参数	描述
`{{ value }}`	当前（无效）值
`{{ label }}`	对应的表单字段标签

`payload`

类型: mixed 默认值: null

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

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

这项工作，包括代码示例，根据 Creative Commons BY-SA 3.0 许可获得许可。

版本