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

Breadcrumb

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

function UlidValidator::validate

Overrides ConstraintValidatorInterface::validate

File

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

Class

UlidValidator
Validates whether the value is a valid ULID (Universally Unique Lexicographically Sortable Identifier). Cf https://github.com/ulid/spec for ULID specifications.

Namespace

Symfony\Component\Validator\Constraints

Code

public function validate(mixed $value, Constraint $constraint) : void {
    if (!$constraint instanceof Ulid) {
        throw new UnexpectedTypeException($constraint, Ulid::class);
    }
    if (null === $value || '' === $value) {
        return;
    }
    if (!\is_scalar($value) && !$value instanceof \Stringable) {
        throw new UnexpectedValueException($value, 'string');
    }
    $value = (string) $value;
    [
        $requiredLength,
        $requiredCharset,
    ] = match ($constraint->format) {    Ulid::FORMAT_BASE_32 => [
            26,
            '0123456789ABCDEFGHJKMNPQRSTVWXYZabcdefghjkmnpqrstvwxyz',
        ],
        Ulid::FORMAT_BASE_58 => [
            22,
            '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
        ],
        Ulid::FORMAT_RFC_4122 => [
            36,
            '0123456789ABCDEFabcdef-',
        ],
    
    };
    if ($requiredLength !== \strlen($value)) {
        $this->context
            ->buildViolation($constraint->message)
            ->setParameters([
            '{{ value }}' => $this->formatValue($value),
            '{{ format }}' => $constraint->format,
        ])
            ->setCode($requiredLength > \strlen($value) ? Ulid::TOO_SHORT_ERROR : Ulid::TOO_LONG_ERROR)
            ->addViolation();
        return;
    }
    if (\strlen($value) !== strspn($value, $requiredCharset)) {
        $this->context
            ->buildViolation($constraint->message)
            ->setParameters([
            '{{ value }}' => $this->formatValue($value),
            '{{ format }}' => $constraint->format,
        ])
            ->setCode(Ulid::INVALID_CHARACTERS_ERROR)
            ->addViolation();
        return;
    }
    if (Ulid::FORMAT_BASE_32 === $constraint->format) {
        // Largest valid ULID is '7ZZZZZZZZZZZZZZZZZZZZZZZZZ'
        // Cf https://github.com/ulid/spec#overflow-errors-when-parsing-base32-strings
        if ($value[0] > '7') {
            $this->context
                ->buildViolation($constraint->message)
                ->setParameters([
                '{{ value }}' => $this->formatValue($value),
                '{{ format }}' => $constraint->format,
            ])
                ->setCode(Ulid::TOO_LARGE_ERROR)
                ->addViolation();
        }
    }
    elseif (Ulid::FORMAT_RFC_4122 === $constraint->format) {
        if (!preg_match('/^[^-]{8}-[^-]{4}-[^-]{4}-[^-]{4}-[^-]{12}$/', $value)) {
            $this->context
                ->buildViolation($constraint->message)
                ->setParameters([
                '{{ value }}' => $this->formatValue($value),
                '{{ format }}' => $constraint->format,
            ])
                ->setCode(Ulid::INVALID_FORMAT_ERROR)
                ->addViolation();
        }
    }
}

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal