You are here

Home » API reference » Plug 7 » UuidValidator.php

class UuidValidator in Plug 7

Validates whether the value is a valid UUID per RFC 4122.

@author Colin O'Dell <colinodell@gmail.com> @author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

Expanded class hierarchy of UuidValidator

See also

http://tools.ietf.org/html/rfc4122

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

1 file declares its use of UuidValidator
UuidValidatorTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/UuidValidatorTest.php

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/UuidValidator.php, line 27

Namespace

Symfony\Component\Validator\Constraints
View source 
class UuidValidator extends ConstraintValidator {

  // The strict pattern matches UUIDs like this:
  // xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
  // Roughly speaking:
  // x = any hexadecimal character
  // M = any allowed version {1..5}
  // N = any allowed variant {8, 9, a, b}
  const STRICT_LENGTH = 36;
  const STRICT_FIRST_HYPHEN_POSITION = 8;
  const STRICT_LAST_HYPHEN_POSITION = 23;
  const STRICT_VERSION_POSITION = 14;
  const STRICT_VARIANT_POSITION = 19;

  // The loose pattern validates similar yet non-compliant UUIDs.
  // Hyphens are completely optional. If present, they should only appear
  // between every fourth character:
  // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
  // xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxx
  // xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  // The value can also be wrapped with characters like []{}:
  // {xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx}
  // Neither the version nor the variant is validated by this pattern.
  const LOOSE_MAX_LENGTH = 39;
  const LOOSE_FIRST_HYPHEN_POSITION = 4;

  /**
   * @deprecated Deprecated since Symfony 2.6, to be removed in 3.0
   */
  const STRICT_PATTERN = '/^[a-f0-9]{8}-[a-f0-9]{4}-[%s][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$/i';

  /**
   * @deprecated Deprecated since Symfony 2.6, to be removed in 3.0
   */
  const LOOSE_PATTERN = '/^[a-f0-9]{4}(?:-?[a-f0-9]{4}){7}$/i';

  /**
   * @deprecated Deprecated since Symfony 2.6, to be removed in 3.0
   */
  const STRICT_UUID_LENGTH = self::STRICT_LENGTH;

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (null === $value || '' === $value) {
      return;
    }
    if (!is_scalar($value) && !(is_object($value) && method_exists($value, '__toString'))) {
      throw new UnexpectedTypeException($value, 'string');
    }
    $value = (string) $value;
    if ($constraint->strict) {
      $this
        ->validateStrict($value, $constraint);
      return;
    }
    $this
      ->validateLoose($value, $constraint);
  }
  private function validateLoose($value, Uuid $constraint) {

    // Error priority:
    // 1. ERROR_INVALID_CHARACTERS
    // 2. ERROR_INVALID_HYPHEN_PLACEMENT
    // 3. ERROR_TOO_SHORT/ERROR_TOO_LONG
    // Trim any wrapping characters like [] or {} used by some legacy systems
    $trimmed = trim($value, '[]{}');

    // Position of the next expected hyphen
    $h = self::LOOSE_FIRST_HYPHEN_POSITION;

    // Expected length
    $l = self::LOOSE_MAX_LENGTH;
    for ($i = 0; $i < $l; ++$i) {

      // Check length
      if (!isset($trimmed[$i])) {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Uuid::TOO_SHORT_ERROR)
          ->addViolation();
        return;
      }

      // Hyphens must occur every fifth position
      // xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx-xxxx
      //     ^    ^    ^    ^    ^    ^    ^
      if ('-' === $trimmed[$i]) {
        if ($i !== $h) {
          $this
            ->buildViolation($constraint->message)
            ->setParameter('{{ value }}', $this
            ->formatValue($value))
            ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)
            ->addViolation();
          return;
        }
        $h += 5;
        continue;
      }

      // Missing hyphens are ignored
      if ($i === $h) {
        $h += 4;
        --$l;
      }

      // Check characters
      if (!ctype_xdigit($trimmed[$i])) {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Uuid::INVALID_CHARACTERS_ERROR)
          ->addViolation();
        return;
      }
    }

    // Check length again
    if (isset($trimmed[$i])) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->setCode(Uuid::TOO_LONG_ERROR)
        ->addViolation();
    }
  }
  private function validateStrict($value, Uuid $constraint) {

    // Error priority:
    // 1. ERROR_INVALID_CHARACTERS
    // 2. ERROR_INVALID_HYPHEN_PLACEMENT
    // 3. ERROR_TOO_SHORT/ERROR_TOO_LONG
    // 4. ERROR_INVALID_VERSION
    // 5. ERROR_INVALID_VARIANT
    // Position of the next expected hyphen
    $h = self::STRICT_FIRST_HYPHEN_POSITION;
    for ($i = 0; $i < self::STRICT_LENGTH; ++$i) {

      // Check length
      if (!isset($value[$i])) {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Uuid::TOO_SHORT_ERROR)
          ->addViolation();
        return;
      }

      // Check hyphen placement
      // xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      //         ^    ^    ^    ^
      if ('-' === $value[$i]) {
        if ($i !== $h) {
          $this
            ->buildViolation($constraint->message)
            ->setParameter('{{ value }}', $this
            ->formatValue($value))
            ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)
            ->addViolation();
          return;
        }

        // xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        //                        ^
        if ($h < self::STRICT_LAST_HYPHEN_POSITION) {
          $h += 5;
        }
        continue;
      }

      // Check characters
      if (!ctype_xdigit($value[$i])) {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Uuid::INVALID_CHARACTERS_ERROR)
          ->addViolation();
        return;
      }

      // Missing hyphen
      if ($i === $h) {
        $this
          ->buildViolation($constraint->message)
          ->setParameter('{{ value }}', $this
          ->formatValue($value))
          ->setCode(Uuid::INVALID_HYPHEN_PLACEMENT_ERROR)
          ->addViolation();
        return;
      }
    }

    // Check length again
    if (isset($value[$i])) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->setCode(Uuid::TOO_LONG_ERROR)
        ->addViolation();
    }

    // Check version
    if (!in_array($value[self::STRICT_VERSION_POSITION], $constraint->versions)) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->setCode(Uuid::INVALID_VERSION_ERROR)
        ->addViolation();
    }

    // Check variant - first two bits must equal "10"
    //   0b10xx
    // & 0b1100 (12)
    // = 0b1000 (8)
    if ((hexdec($value[self::STRICT_VARIANT_POSITION]) & 12) !== 8) {
      $this
        ->buildViolation($constraint->message)
        ->setParameter('{{ value }}', $this
        ->formatValue($value))
        ->setCode(Uuid::INVALID_VARIANT_ERROR)
        ->addViolation();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConstraintValidator::$context protected property
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").
UuidValidator::LOOSE_FIRST_HYPHEN_POSITION constant
UuidValidator::LOOSE_MAX_LENGTH constant
UuidValidator::LOOSE_PATTERN Deprecated constant
UuidValidator::STRICT_FIRST_HYPHEN_POSITION constant
UuidValidator::STRICT_LAST_HYPHEN_POSITION constant
UuidValidator::STRICT_LENGTH constant
UuidValidator::STRICT_PATTERN Deprecated constant
UuidValidator::STRICT_UUID_LENGTH Deprecated constant
UuidValidator::STRICT_VARIANT_POSITION constant
UuidValidator::STRICT_VERSION_POSITION constant
UuidValidator::validate public function Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate
UuidValidator::validateLoose private function
UuidValidator::validateStrict private function