Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. LuhnValidator.php

class LuhnValidator

Validates a PAN using the LUHN Algorithm.

For a list of example card numbers that are used to test this class, please see the LuhnValidatorTest class.

@author Tim Nagel <t.nagel@infinite.net.au> @author Greg Knapp http://gregk.me/2011/php-implementation-of-bank-card-luhn-algorithm/ @author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

  • class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
    • class \Symfony\Component\Validator\Constraints\LuhnValidator extends \Symfony\Component\Validator\ConstraintValidator

Expanded class hierarchy of LuhnValidator

See also

http://en.wikipedia.org/wiki/Luhn_algorithm

File

vendor/symfony/validator/Constraints/LuhnValidator.php, line 31

Namespace

Symfony\Component\Validator\Constraints
View source
class LuhnValidator extends ConstraintValidator {
    public function validate(mixed $value, Constraint $constraint) : void {
        if (!$constraint instanceof Luhn) {
            throw new UnexpectedTypeException($constraint, Luhn::class);
        }
        if (null === $value || '' === $value) {
            return;
        }
        // Work with strings only, because long numbers are represented as floats
        // internally and don't work with strlen()
        if (!\is_string($value) && !$value instanceof \Stringable) {
            throw new UnexpectedValueException($value, 'string');
        }
        $value = (string) $value;
        if (!ctype_digit($value)) {
            $this->context
                ->buildViolation($constraint->message)
                ->setParameter('{{ value }}', $this->formatValue($value))
                ->setCode(Luhn::INVALID_CHARACTERS_ERROR)
                ->addViolation();
            return;
        }
        $checkSum = 0;
        $length = \strlen($value);
        for ($i = $length - 1; $i >= 0; --$i) {
            if ($i % 2 ^ $length % 2) {
                // Starting with the last digit and walking left, add every second
                // digit to the check sum
                // e.g. 7  9  9  2  7  3  9  8  7  1  3
                //      ^     ^     ^     ^     ^     ^
                //    = 7  +  9  +  7  +  9  +  7  +  3
                $checkSum += (int) $value[$i];
            }
            else {
                // Starting with the second last digit and walking left, double every
                // second digit and add it to the check sum
                // For doubles greater than 9, sum the individual digits
                // e.g. 7  9  9  2  7  3  9  8  7  1  3
                //         ^     ^     ^     ^     ^
                //    =    1+8 + 4  +  6  +  1+6 + 2
                $checkSum += (int) (2 * $value[$i] / 10) + 2 * $value[$i] % 10;
            }
        }
        if (0 === $checkSum || 0 !== $checkSum % 10) {
            $this->context
                ->buildViolation($constraint->message)
                ->setParameter('{{ value }}', $this->formatValue($value))
                ->setCode(Luhn::CHECKSUM_FAILED_ERROR)
                ->addViolation();
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
ConstraintValidator::$context protected property
ConstraintValidator::formatTypeOf protected function Returns a string representation of the type of the value.
ConstraintValidator::formatValue protected function Returns a string representation of the value.
ConstraintValidator::formatValues protected function Returns a string representation of a list of values.
ConstraintValidator::initialize public function Initializes the constraint validator. Overrides ConstraintValidatorInterface::initialize
ConstraintValidator::OBJECT_TO_STRING public constant Whether to cast objects with a &quot;__toString()&quot; method to strings.
ConstraintValidator::PRETTY_DATE public constant Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter}
(if it is available) or as RFC-3339 dates (&quot;Y-m-d H:i:s&quot;).
LuhnValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
RSS feed
Powered by Drupal