class IssnValidator in Zircon Profile 8

Validates whether the value is a valid ISSN.

@author Antonio J. García Lagar <[e-mail]> @author Bernhard Schussek <[e-mail]>

Hierarchy

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

See also

https://en.wikipedia.org/wiki/Issn

1 file declares its use of IssnValidator

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

File

vendor/symfony/validator/Constraints/IssnValidator.php, line 27

Namespace

Symfony\Component\Validator\Constraints

class IssnValidator extends ConstraintValidator {

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof Issn) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Issn');
    }
    if (null === $value || '' === $value) {
      return;
    }
    if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {
      throw new UnexpectedTypeException($value, 'string');
    }
    $value = (string) $value;
    $canonical = $value;

    // 1234-567X
    //     ^
    if (isset($canonical[4]) && '-' === $canonical[4]) {

      // remove hyphen
      $canonical = substr($canonical, 0, 4) . substr($canonical, 5);
    }
    elseif ($constraint->requireHyphen) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::MISSING_HYPHEN_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::MISSING_HYPHEN_ERROR)
          ->addViolation();
      }
      return;
    }
    $length = strlen($canonical);
    if ($length < 8) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::TOO_SHORT_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::TOO_SHORT_ERROR)
          ->addViolation();
      }
      return;
    }
    if ($length > 8) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::TOO_LONG_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::TOO_LONG_ERROR)
          ->addViolation();
      }
      return;
    }

    // 1234567X
    // ^^^^^^^ digits only
    if (!ctype_digit(substr($canonical, 0, 7))) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      return;
    }

    // 1234567X
    //        ^ digit, x or X
    if (!ctype_digit($canonical[7]) && 'x' !== $canonical[7] && 'X' !== $canonical[7]) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CHARACTERS_ERROR)
          ->addViolation();
      }
      return;
    }

    // 1234567X
    //        ^ case-sensitive?
    if ($constraint->caseSensitive && 'x' === $canonical[7]) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CASE_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::INVALID_CASE_ERROR)
          ->addViolation();
      }
      return;
    }

    // Calculate a checksum. "X" equals 10.
    $checkSum = 'X' === $canonical[7] || 'x' === $canonical[7] ? 10 : $canonical[7];
    for ($i = 0; $i < 7; ++$i) {

      // Multiply the first digit by 8, the second by 7, etc.
      $checkSum += (8 - $i) * $canonical[$i];
    }
    if (0 !== $checkSum % 11) {
      if ($this->context instanceof ExecutionContextInterface) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::CHECKSUM_FAILED_ERROR)
          ->addViolation();
      }
      else {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Issn::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").
IssnValidator::validate	public	function	Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate