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

Breadcrumb

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

function ImageValidator::validate

Overrides FileValidator::validate

File

vendor/symfony/validator/Constraints/ImageValidator.php, line 28

Class

ImageValidator
Validates whether a value is a valid image file and is valid against minWidth, maxWidth, minHeight and maxHeight constraints.

Namespace

Symfony\Component\Validator\Constraints

Code

public function validate(mixed $value, Constraint $constraint) : void {
    if (!$constraint instanceof Image) {
        throw new UnexpectedTypeException($constraint, Image::class);
    }
    $violations = \count($this->context
        ->getViolations());
    parent::validate($value, $constraint);
    $failed = \count($this->context
        ->getViolations()) !== $violations;
    if ($failed || null === $value || '' === $value) {
        return;
    }
    if (null === $constraint->minWidth && null === $constraint->maxWidth && null === $constraint->minHeight && null === $constraint->maxHeight && null === $constraint->minPixels && null === $constraint->maxPixels && null === $constraint->minRatio && null === $constraint->maxRatio && $constraint->allowSquare && $constraint->allowLandscape && $constraint->allowPortrait && !$constraint->detectCorrupted) {
        return;
    }
    $size = @getimagesize($value);
    if (!$size || 0 === $size[0] || 0 === $size[1]) {
        $this->context
            ->buildViolation($constraint->sizeNotDetectedMessage)
            ->setCode(Image::SIZE_NOT_DETECTED_ERROR)
            ->addViolation();
        return;
    }
    $width = $size[0];
    $height = $size[1];
    if ($constraint->minWidth) {
        if (!ctype_digit((string) $constraint->minWidth)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid minimum width.', $constraint->minWidth));
        }
        if ($width < $constraint->minWidth) {
            $this->context
                ->buildViolation($constraint->minWidthMessage)
                ->setParameter('{{ width }}', $width)
                ->setParameter('{{ min_width }}', $constraint->minWidth)
                ->setCode(Image::TOO_NARROW_ERROR)
                ->addViolation();
            return;
        }
    }
    if ($constraint->maxWidth) {
        if (!ctype_digit((string) $constraint->maxWidth)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid maximum width.', $constraint->maxWidth));
        }
        if ($width > $constraint->maxWidth) {
            $this->context
                ->buildViolation($constraint->maxWidthMessage)
                ->setParameter('{{ width }}', $width)
                ->setParameter('{{ max_width }}', $constraint->maxWidth)
                ->setCode(Image::TOO_WIDE_ERROR)
                ->addViolation();
            return;
        }
    }
    if ($constraint->minHeight) {
        if (!ctype_digit((string) $constraint->minHeight)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid minimum height.', $constraint->minHeight));
        }
        if ($height < $constraint->minHeight) {
            $this->context
                ->buildViolation($constraint->minHeightMessage)
                ->setParameter('{{ height }}', $height)
                ->setParameter('{{ min_height }}', $constraint->minHeight)
                ->setCode(Image::TOO_LOW_ERROR)
                ->addViolation();
            return;
        }
    }
    if ($constraint->maxHeight) {
        if (!ctype_digit((string) $constraint->maxHeight)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid maximum height.', $constraint->maxHeight));
        }
        if ($height > $constraint->maxHeight) {
            $this->context
                ->buildViolation($constraint->maxHeightMessage)
                ->setParameter('{{ height }}', $height)
                ->setParameter('{{ max_height }}', $constraint->maxHeight)
                ->setCode(Image::TOO_HIGH_ERROR)
                ->addViolation();
        }
    }
    $pixels = $width * $height;
    if (null !== $constraint->minPixels) {
        if (!ctype_digit((string) $constraint->minPixels)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid minimum amount of pixels.', $constraint->minPixels));
        }
        if ($pixels < $constraint->minPixels) {
            $this->context
                ->buildViolation($constraint->minPixelsMessage)
                ->setParameter('{{ pixels }}', $pixels)
                ->setParameter('{{ min_pixels }}', $constraint->minPixels)
                ->setParameter('{{ height }}', $height)
                ->setParameter('{{ width }}', $width)
                ->setCode(Image::TOO_FEW_PIXEL_ERROR)
                ->addViolation();
        }
    }
    if (null !== $constraint->maxPixels) {
        if (!ctype_digit((string) $constraint->maxPixels)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid maximum amount of pixels.', $constraint->maxPixels));
        }
        if ($pixels > $constraint->maxPixels) {
            $this->context
                ->buildViolation($constraint->maxPixelsMessage)
                ->setParameter('{{ pixels }}', $pixels)
                ->setParameter('{{ max_pixels }}', $constraint->maxPixels)
                ->setParameter('{{ height }}', $height)
                ->setParameter('{{ width }}', $width)
                ->setCode(Image::TOO_MANY_PIXEL_ERROR)
                ->addViolation();
        }
    }
    $ratio = round($width / $height, 2);
    if (null !== $constraint->minRatio) {
        if (!is_numeric((string) $constraint->minRatio)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid minimum ratio.', $constraint->minRatio));
        }
        if ($ratio < round($constraint->minRatio, 2)) {
            $this->context
                ->buildViolation($constraint->minRatioMessage)
                ->setParameter('{{ ratio }}', $ratio)
                ->setParameter('{{ min_ratio }}', round($constraint->minRatio, 2))
                ->setCode(Image::RATIO_TOO_SMALL_ERROR)
                ->addViolation();
        }
    }
    if (null !== $constraint->maxRatio) {
        if (!is_numeric((string) $constraint->maxRatio)) {
            throw new ConstraintDefinitionException(\sprintf('"%s" is not a valid maximum ratio.', $constraint->maxRatio));
        }
        if ($ratio > round($constraint->maxRatio, 2)) {
            $this->context
                ->buildViolation($constraint->maxRatioMessage)
                ->setParameter('{{ ratio }}', $ratio)
                ->setParameter('{{ max_ratio }}', round($constraint->maxRatio, 2))
                ->setCode(Image::RATIO_TOO_BIG_ERROR)
                ->addViolation();
        }
    }
    if (!$constraint->allowSquare && $width == $height) {
        $this->context
            ->buildViolation($constraint->allowSquareMessage)
            ->setParameter('{{ width }}', $width)
            ->setParameter('{{ height }}', $height)
            ->setCode(Image::SQUARE_NOT_ALLOWED_ERROR)
            ->addViolation();
    }
    if (!$constraint->allowLandscape && $width > $height) {
        $this->context
            ->buildViolation($constraint->allowLandscapeMessage)
            ->setParameter('{{ width }}', $width)
            ->setParameter('{{ height }}', $height)
            ->setCode(Image::LANDSCAPE_NOT_ALLOWED_ERROR)
            ->addViolation();
    }
    if (!$constraint->allowPortrait && $width < $height) {
        $this->context
            ->buildViolation($constraint->allowPortraitMessage)
            ->setParameter('{{ width }}', $width)
            ->setParameter('{{ height }}', $height)
            ->setCode(Image::PORTRAIT_NOT_ALLOWED_ERROR)
            ->addViolation();
    }
    if ($constraint->detectCorrupted) {
        if (!\function_exists('imagecreatefromstring')) {
            throw new LogicException('Corrupted images detection requires installed and enabled GD extension.');
        }
        $resource = @imagecreatefromstring(file_get_contents($value));
        if (false === $resource) {
            $this->context
                ->buildViolation($constraint->corruptedMessage)
                ->setCode(Image::CORRUPTED_IMAGE_ERROR)
                ->addViolation();
            return;
        }
        imagedestroy($resource);
    }
}

API Navigation

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