You are browsing the documentation for Symfony 2.4 which is not maintained anymore.
Consider upgrading your projects to Symfony 5.2.
Luhn
Luhn¶
New in version 2.2: The Luhn
constraint was introduced 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 | Symfony\Component\Validator\Constraints\Luhn |
Validator | Symfony\Component\Validator\Constraints\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
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.
- Annotations
1 2 3 4 5 6 7 8 9 10 11 12
// src/Acme/SubscriptionBundle/Entity/Transaction.php namespace Acme\SubscriptionBundle\Entity; use Symfony\Component\Validator\Constraints as Assert; class Transaction { /** * @Assert\Luhn(message = "Please check your credit card number.") */ protected $cardNumber; }
- XML
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!-- 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="Luhn"> <option name="message">Please check your credit card number.</option> </constraint> </property> </class> </constraint-mapping>
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
// src/Acme/SubscriptionBundle/Entity/Transaction.php namespace Acme\SubscriptionBundle\Entity; 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\Luhn(array( 'message' => 'Please check your credit card number', ))); } }
This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.