class UlidValidator

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

@author Laurent Clouet <laurent35240@gmail.com>

Hierarchy

class \Symfony\Component\Validator\ConstraintValidator implements \Symfony\Component\Validator\ConstraintValidatorInterface
- class \Symfony\Component\Validator\Constraints\UlidValidator extends \Symfony\Component\Validator\ConstraintValidator

Expanded class hierarchy of UlidValidator

File

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

Namespace

Symfony\Component\Validator\Constraints

View source

class UlidValidator extends ConstraintValidator {
    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();
            }
        }
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
ConstraintValidator::$context	protected	property
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
ConstraintValidator::OBJECT_TO_STRING	public	constant	Whether to cast objects with a "__toString()" method to strings.
ConstraintValidator::PRETTY_DATE	public	constant	Whether to format {@link \DateTime} objects, either with the {@link \IntlDateFormatter} (if it is available) or as RFC-3339 dates ("Y-m-d H:i:s").
UlidValidator::validate	public	function	Checks if the passed value is valid.	Overrides ConstraintValidatorInterface::validate