Luhn ¶

This constraint is used to ensure that a credit card number passes the Luhn algorithm. It is useful as a first step to validating a credit card: before communicating with a payment gateway.

この制約は、クレジットカード番号が Luhn アルゴリズムを通過することを保証するために使用されます。クレジットカードを検証するための最初のステップとして、支払いゲートウェイと通信する前に役立ちます。

Applies to	property or method
Class	Luhn
Validator	LuhnValidator

Basic Usage ¶

To use the Luhn validator, apply it to a property on an object that will contain a credit card number.

Luhn バリデーターを使用するには、クレジットカード番号を含むオブジェクトのプロパティに適用します。

Attributes
属性
YAML
YAML
XML
XML
PHP
PHP

    
                        // 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 $cardNumber;
}

    
                        # config/validator/validation.yaml
App\Entity\Transaction:
    properties:
        cardNumber:
            - Luhn:
                message: Please check your credit card number.

    
                        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/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>

    
                        // 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)
    {
        $metadata->addPropertyConstraint('cardNumber', new Assert\Luhn([
            'message' => 'Please check your credit card number',
        ]));
    }
}

Note

ノート

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

他のほとんどの制約と同様に、null および空の文字列は有効な値と見なされます。これは、それらをオプションの値にできるようにするためです。値が必須の場合、一般的な解決策は、この制約と NotBlank を組み合わせることです。

Options ¶

`groups` ¶

type: array | string

タイプ: 配列 |ストリング

It defines the validation group or groups of this constraint. Read more about validation groups.

この制約の検証グループを定義します。検証グループの詳細を参照してください。

`message` ¶

type: string default: Invalid card number.

タイプ: 文字列デフォルト: 無効なカード番号。

The default message supplied when the value does not pass the Luhn check.

値が Luhn チェックに合格しなかった場合に提供されるデフォルトのメッセージ。

You can use the following parameters in this message:

このメッセージでは、次のパラメーターを使用できます。

Parameter	Description
`{{ value }}`	The current (invalid) value
`{{ label }}`	Corresponding form field label

`payload` ¶

type: mixed default: null

タイプ: 混合デフォルト: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

このオプションは、任意のドメイン固有のデータを制約に添付するために使用できます。構成されたペイロードは Validator コンポーネントによって使用されませんが、その処理は完全にユーザー次第です。

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

たとえば、いくつかのエラーレベルを使用して、エラーの重大度に応じて、失敗した制約をフロントエンドで異なる方法で提示することができます。

Luhn ¶

Basic Usage ¶

Options ¶

groups ¶

message ¶

payload ¶

`groups` ¶

`message` ¶

`payload` ¶