class ImageValidator in Plug 7

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

@author Benjamin Dulau <[e-mail]> @author Bernhard Schussek <[e-mail]>

Hierarchy

• class \Symfony\Component\Validator\ConstraintValidator implements ConstraintValidatorInterface
  • class \Symfony\Component\Validator\Constraints\FileValidator
    • class \Symfony\Component\Validator\Constraints\ImageValidator

1 file declares its use of ImageValidator

ImageValidatorTest.php in lib/Symfony/validator/Symfony/Component/Validator/Tests/Constraints/ImageValidatorTest.php

File

lib/Symfony/validator/Symfony/Component/Validator/Constraints/ImageValidator.php, line 25

Namespace

Symfony\Component\Validator\Constraints

class ImageValidator extends FileValidator {

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof Image) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\Image');
    }
    $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->minRatio && null === $constraint->maxRatio && $constraint->allowSquare && $constraint->allowLandscape && $constraint->allowPortrait) {
      return;
    }
    $size = @getimagesize($value);
    if (empty($size) || $size[0] === 0 || $size[1] === 0) {
      $this
        ->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
          ->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
          ->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
          ->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
          ->buildViolation($constraint->maxHeightMessage)
          ->setParameter('{{ height }}', $height)
          ->setParameter('{{ max_height }}', $constraint->maxHeight)
          ->setCode(Image::TOO_HIGH_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 < $constraint->minRatio) {
        $this
          ->buildViolation($constraint->minRatioMessage)
          ->setParameter('{{ ratio }}', $ratio)
          ->setParameter('{{ min_ratio }}', $constraint->minRatio)
          ->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 > $constraint->maxRatio) {
        $this
          ->buildViolation($constraint->maxRatioMessage)
          ->setParameter('{{ ratio }}', $ratio)
          ->setParameter('{{ max_ratio }}', $constraint->maxRatio)
          ->setCode(Image::RATIO_TOO_BIG_ERROR)
          ->addViolation();
      }
    }
    if (!$constraint->allowSquare && $width == $height) {
      $this
        ->buildViolation($constraint->allowSquareMessage)
        ->setParameter('{{ width }}', $width)
        ->setParameter('{{ height }}', $height)
        ->setCode(Image::SQUARE_NOT_ALLOWED_ERROR)
        ->addViolation();
    }
    if (!$constraint->allowLandscape && $width > $height) {
      $this
        ->buildViolation($constraint->allowLandscapeMessage)
        ->setParameter('{{ width }}', $width)
        ->setParameter('{{ height }}', $height)
        ->setCode(Image::LANDSCAPE_NOT_ALLOWED_ERROR)
        ->addViolation();
    }
    if (!$constraint->allowPortrait && $width < $height) {
      $this
        ->buildViolation($constraint->allowPortraitMessage)
        ->setParameter('{{ width }}', $width)
        ->setParameter('{{ height }}', $height)
        ->setCode(Image::PORTRAIT_NOT_ALLOWED_ERROR)
        ->addViolation();
    }
  }

}

Members

Name	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").
FileValidator::$suffices	private static	property
FileValidator::factorizeSizes	private	function	Convert the limit to the smallest possible number (i.e. try "MB", then "kB", then "bytes")
FileValidator::KB_BYTES		constant
FileValidator::KIB_BYTES		constant
FileValidator::MB_BYTES		constant
FileValidator::MIB_BYTES		constant
FileValidator::moreDecimalsThan	private static	function
ImageValidator::validate	public	function	Checks if the passed value is valid. Overrides FileValidator::validate