annotate vendor/symfony/validator/Constraints/IssnValidator.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Validator\Constraints;
Chris@0 13
Chris@0 14 use Symfony\Component\Validator\Constraint;
Chris@0 15 use Symfony\Component\Validator\ConstraintValidator;
Chris@0 16 use Symfony\Component\Validator\Exception\UnexpectedTypeException;
Chris@0 17
Chris@0 18 /**
Chris@0 19 * Validates whether the value is a valid ISSN.
Chris@0 20 *
Chris@0 21 * @author Antonio J. GarcĂ­a Lagar <aj@garcialagar.es>
Chris@0 22 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 23 *
Chris@0 24 * @see https://en.wikipedia.org/wiki/Issn
Chris@0 25 */
Chris@0 26 class IssnValidator extends ConstraintValidator
Chris@0 27 {
Chris@0 28 /**
Chris@0 29 * {@inheritdoc}
Chris@0 30 */
Chris@0 31 public function validate($value, Constraint $constraint)
Chris@0 32 {
Chris@0 33 if (!$constraint instanceof Issn) {
Chris@0 34 throw new UnexpectedTypeException($constraint, __NAMESPACE__.'\Issn');
Chris@0 35 }
Chris@0 36
Chris@0 37 if (null === $value || '' === $value) {
Chris@0 38 return;
Chris@0 39 }
Chris@0 40
Chris@17 41 if (!is_scalar($value) && !(\is_object($value) && method_exists($value, '__toString'))) {
Chris@0 42 throw new UnexpectedTypeException($value, 'string');
Chris@0 43 }
Chris@0 44
Chris@0 45 $value = (string) $value;
Chris@0 46 $canonical = $value;
Chris@0 47
Chris@0 48 // 1234-567X
Chris@0 49 // ^
Chris@0 50 if (isset($canonical[4]) && '-' === $canonical[4]) {
Chris@0 51 // remove hyphen
Chris@0 52 $canonical = substr($canonical, 0, 4).substr($canonical, 5);
Chris@0 53 } elseif ($constraint->requireHyphen) {
Chris@0 54 $this->context->buildViolation($constraint->message)
Chris@0 55 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 56 ->setCode(Issn::MISSING_HYPHEN_ERROR)
Chris@0 57 ->addViolation();
Chris@0 58
Chris@0 59 return;
Chris@0 60 }
Chris@0 61
Chris@17 62 $length = \strlen($canonical);
Chris@0 63
Chris@0 64 if ($length < 8) {
Chris@0 65 $this->context->buildViolation($constraint->message)
Chris@0 66 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 67 ->setCode(Issn::TOO_SHORT_ERROR)
Chris@0 68 ->addViolation();
Chris@0 69
Chris@0 70 return;
Chris@0 71 }
Chris@0 72
Chris@0 73 if ($length > 8) {
Chris@0 74 $this->context->buildViolation($constraint->message)
Chris@0 75 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 76 ->setCode(Issn::TOO_LONG_ERROR)
Chris@0 77 ->addViolation();
Chris@0 78
Chris@0 79 return;
Chris@0 80 }
Chris@0 81
Chris@0 82 // 1234567X
Chris@0 83 // ^^^^^^^ digits only
Chris@0 84 if (!ctype_digit(substr($canonical, 0, 7))) {
Chris@0 85 $this->context->buildViolation($constraint->message)
Chris@0 86 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 87 ->setCode(Issn::INVALID_CHARACTERS_ERROR)
Chris@0 88 ->addViolation();
Chris@0 89
Chris@0 90 return;
Chris@0 91 }
Chris@0 92
Chris@0 93 // 1234567X
Chris@0 94 // ^ digit, x or X
Chris@0 95 if (!ctype_digit($canonical[7]) && 'x' !== $canonical[7] && 'X' !== $canonical[7]) {
Chris@0 96 $this->context->buildViolation($constraint->message)
Chris@0 97 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 98 ->setCode(Issn::INVALID_CHARACTERS_ERROR)
Chris@0 99 ->addViolation();
Chris@0 100
Chris@0 101 return;
Chris@0 102 }
Chris@0 103
Chris@0 104 // 1234567X
Chris@0 105 // ^ case-sensitive?
Chris@0 106 if ($constraint->caseSensitive && 'x' === $canonical[7]) {
Chris@0 107 $this->context->buildViolation($constraint->message)
Chris@0 108 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 109 ->setCode(Issn::INVALID_CASE_ERROR)
Chris@0 110 ->addViolation();
Chris@0 111
Chris@0 112 return;
Chris@0 113 }
Chris@0 114
Chris@0 115 // Calculate a checksum. "X" equals 10.
Chris@0 116 $checkSum = 'X' === $canonical[7]
Chris@0 117 || 'x' === $canonical[7]
Chris@0 118 ? 10
Chris@0 119 : $canonical[7];
Chris@0 120
Chris@0 121 for ($i = 0; $i < 7; ++$i) {
Chris@0 122 // Multiply the first digit by 8, the second by 7, etc.
Chris@0 123 $checkSum += (8 - $i) * $canonical[$i];
Chris@0 124 }
Chris@0 125
Chris@0 126 if (0 !== $checkSum % 11) {
Chris@0 127 $this->context->buildViolation($constraint->message)
Chris@0 128 ->setParameter('{{ value }}', $this->formatValue($value))
Chris@0 129 ->setCode(Issn::CHECKSUM_FAILED_ERROR)
Chris@0 130 ->addViolation();
Chris@0 131 }
Chris@0 132 }
Chris@0 133 }