CardScheme ¶
This constraint ensures that a credit card number is valid for a given credit card company. It can be used to validate the number before trying to initiate a payment through a payment gateway.
Applies to | property or method |
Class | CardScheme |
Validator | CardSchemeValidator |
Basic Usage ¶
To use the CardScheme
validator, apply it to a property or method
on an object that will contain a credit card number.
-
Attributes
属性
-
YAML
YAML
-
XML
XML
-
PHP
PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 |
// src/Entity/Transaction.php
namespace App\Entity;
use Symfony\Component\Validator\Constraints as Assert;
class Transaction
{
#[Assert\CardScheme(
schemes: [Assert\CardScheme::VISA],
message: 'Your credit card number is invalid.',
)]
protected $cardNumber;
}
|
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.
Available Options ¶
groups
¶
type: array
| string
It defines the validation group or groups of this constraint. Read more about validation groups.
message
¶
type: string
default: Unsupported card type or invalid card number.
The message shown when the value does not pass the CardScheme
check.
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
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.
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.
schemes
¶
type: mixed
[default option]
This option is required and represents the name of the number scheme used to validate the credit card number, it can either be a string or an array. Valid values are:
AMEX
アメックスCHINA_UNIONPAY
CHINA_UNIONPAYDINERS
食事客DISCOVER
発見するINSTAPAYMENT
分割払いJCB
JCBLASER
レーザMAESTRO
マエストロMASTERCARD
マスターカードMIR
ミールUATP
UATPVISA
ビザ
For more information about the used schemes, see Wikipedia: Issuer identification number (IIN).