class LuhnValidator in Zircon Profile 8

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 <[e-mail]> @author Greg Knapp http://gregk.me/2011/php-implementation-of-bank-card-luhn-algorithm/ @author Bernhard Schussek <[e-mail]>

Hierarchy

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

See also

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

1 file declares its use of LuhnValidator

LuhnValidatorTest.php in vendor/symfony/validator/Tests/Constraints/LuhnValidatorTest.php

File

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

Namespace

Symfony\Component\Validator\Constraints

class LuhnValidator extends ConstraintValidator {

  /**
   * Validates a credit card number with the Luhn algorithm.
   *
   * @param mixed      $value
   * @param Constraint $constraint
   *
   * @throws UnexpectedTypeException when the given credit card number is no string
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof Luhn) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Luhn');
    }
    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) && !(is_object($value) && method_exists($value, '__toString'))) {
      throw new UnexpectedTypeException($value, 'string');
    }
    $value = (string) $value;
    if (!ctype_digit($value)) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Luhn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Luhn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      return;
    }
    $checkSum = 0;
    $length = strlen($value);

    // 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
    for ($i = $length - 1; $i >= 0; $i -= 2) {
      $checkSum += $value[$i];
    }

    // 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
    for ($i = $length - 2; $i >= 0; $i -= 2) {
      $checkSum += array_sum(str_split($value[$i] * 2));
    }
    if (0 === $checkSum || 0 !== $checkSum % 10) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Luhn::CHECKSUM_FAILED_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Luhn::CHECKSUM_FAILED_ERROR)
          ->addViolation();
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConstraintValidator::$context	protected	property		3
ConstraintValidator::buildViolation Deprecated	protected	function	Wrapper for {@link ExecutionContextInterface::buildViolation} that supports the 2.4 context API.
ConstraintValidator::buildViolationInContext Deprecated	protected	function	Wrapper for {@link ExecutionContextInterface::buildViolation} that supports the 2.4 context API.
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	1
ConstraintValidator::OBJECT_TO_STRING		constant	Whether to cast objects with a "__toString()" method to strings.
ConstraintValidator::PRETTY_DATE		constant	Whether to format {@link \DateTime} objects as RFC-3339 dates ("Y-m-d H:i:s").
LuhnValidator::validate	public	function	Validates a credit card number with the Luhn algorithm. Overrides ConstraintValidatorInterface::validate