Luhn

Version: 2.2
Edit this page

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

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

Luhn

New in version 2.2

The Luhn validation is new in Symfony 2.2.

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.

Applies to property or method
Options
Class Luhn
Validator LuhnValidator

Basic Usage

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

  • YAML
  • Annotations
  • XML
  • PHP
1
2
3
4
5
6
# src/Acme/SubscriptionBundle/Resources/config/validation.yml
Acme\SubscriptionBundle\Entity\Transaction:
    properties:
        cardNumber:
            - Luhn:
                message: Please check your credit card number.

Available Options

message

type: string default: Invalid card number.

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

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