CardScheme

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.

Basic Usage

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

• Annotations

  // src/Entity/Transaction.php
  namespace App\Entity;
  use Symfony\Component\Validator\Constraints as Assert;
  class Transaction
  {
      /**
       * @Assert\CardScheme(
       *     schemes={"VISA"},
       *     message="Your credit card number is invalid."
       * )
       */
      protected $cardNumber;
  }

• YAML

  # config/validator/validation.yaml
  App\Entity\Transaction:
      properties:
          cardNumber:
              - CardScheme:
                  schemes: [VISA]
                  message: Your credit card number is invalid.

• XML

  <!-- 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="CardScheme">
                  <option name="schemes">
                      <value>VISA</value>
                  </option>
                  <option name="message">Your credit card number is invalid.</option>
              </constraint>
          </property>
      </class>
  </constraint-mapping>

• PHP

  // 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\CardScheme([
              'schemes' => [
                  'VISA',
              ],
              'message' => 'Your credit card number is invalid.',
          ]));
      }
  }

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 this constraint belongs to. 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:

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
• DINERS
• DISCOVER
• INSTAPAYMENT
• JCB
• LASER
• MAESTRO
• MASTERCARD
• MIR
• UATP
• VISA

New in version 4.3: The UATP and MIR number schemes were introduced in Symfony 4.3.

For more information about the used schemes, see Wikipedia: Issuer identification number (IIN).

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.