CardScheme

Warning: You are browsing the documentation for Symfony 2.2, which is no longer maintained.

Read the updated version of this page for Symfony 6.2 (the current stable version).

CardScheme

2.2

The CardScheme validation is new in Symfony 2.2.

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
Options	schemes message
Class	CardScheme
Validator	CardSchemeValidator

Basic Usage

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

YAML
XML
Annotations
PHP

        1
2
3
4
5
6
7
        # src/Acme/SubscriptionBundle/Resources/config/validation.yml
Acme\SubscriptionBundle\Entity\Transaction:
    properties:
        cardNumber:
            - CardScheme:
                schemes: [VISA]
                message: Your credit card number is invalid.
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
        <!-- src/Acme/SubscriptionBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="Acme\SubscriptionBundle\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>
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // src/Acme/SubscriptionBundle/Entity/Transaction.php
namespace Acme\SubscriptionBundle\Entity\Transaction;

use Symfony\Component\Validator\Constraints as Assert;

class Transaction
{
    /**
     * @Assert\CardScheme(schemes = {"VISA"}, message = "Your credit card number is invalid.")
     */
    protected $cardNumber;
}
    

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

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

class Transaction
{
    protected $cardNumber;

    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraint('cardNumber', new Assert\CardScheme(array(
            'schemes' => array(
                'VISA'
            ),
            'message' => 'Your credit card number is invalid.',
        )));
    }
}
    

Available Options

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
VISA

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

message

type: string default: Unsupported card type or invalid card number.

The message shown when the value does not pass the CardScheme check.

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

Menu

CardScheme

CardScheme

Basic Usage

Available Options

schemes

message

What is Symfony?

Learn Symfony

Screencasts

Community

Blog

Services

Deployed on