class FileValidator in Plug 7

@author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

class \Symfony\Component\Validator\ConstraintValidator implements ConstraintValidatorInterface
- class \Symfony\Component\Validator\Constraints\FileValidator

Expanded class hierarchy of FileValidator

1 file declares its use of FileValidator

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

File

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

Namespace

Symfony\Component\Validator\Constraints

View source

class FileValidator extends ConstraintValidator {
  const KB_BYTES = 1000;
  const MB_BYTES = 1000000;
  const KIB_BYTES = 1024;
  const MIB_BYTES = 1048576;
  private static $suffices = array(
    1 => 'bytes',
    self::KB_BYTES => 'kB',
    self::MB_BYTES => 'MB',
    self::KIB_BYTES => 'KiB',
    self::MIB_BYTES => 'MiB',
  );

  /**
   * {@inheritdoc}
   */
  public function validate($value, Constraint $constraint) {
    if (!$constraint instanceof File) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\File');
    }
    if (null === $value || '' === $value) {
      return;
    }
    if ($value instanceof UploadedFile && !$value
      ->isValid()) {
      switch ($value
        ->getError()) {
        case UPLOAD_ERR_INI_SIZE:
          $iniLimitSize = UploadedFile::getMaxFilesize();
          if ($constraint->maxSize && $constraint->maxSize < $iniLimitSize) {
            $limitInBytes = $constraint->maxSize;
            $binaryFormat = $constraint->binaryFormat;
          }
          else {
            $limitInBytes = $iniLimitSize;
            $binaryFormat = true;
          }
          list($sizeAsString, $limitAsString, $suffix) = $this
            ->factorizeSizes(0, $limitInBytes, $binaryFormat);
          $this
            ->buildViolation($constraint->uploadIniSizeErrorMessage)
            ->setParameter('{{ limit }}', $limitAsString)
            ->setParameter('{{ suffix }}', $suffix)
            ->setCode(UPLOAD_ERR_INI_SIZE)
            ->addViolation();
          return;
        case UPLOAD_ERR_FORM_SIZE:
          $this
            ->buildViolation($constraint->uploadFormSizeErrorMessage)
            ->setCode(UPLOAD_ERR_FORM_SIZE)
            ->addViolation();
          return;
        case UPLOAD_ERR_PARTIAL:
          $this
            ->buildViolation($constraint->uploadPartialErrorMessage)
            ->setCode(UPLOAD_ERR_PARTIAL)
            ->addViolation();
          return;
        case UPLOAD_ERR_NO_FILE:
          $this
            ->buildViolation($constraint->uploadNoFileErrorMessage)
            ->setCode(UPLOAD_ERR_NO_FILE)
            ->addViolation();
          return;
        case UPLOAD_ERR_NO_TMP_DIR:
          $this
            ->buildViolation($constraint->uploadNoTmpDirErrorMessage)
            ->setCode(UPLOAD_ERR_NO_TMP_DIR)
            ->addViolation();
          return;
        case UPLOAD_ERR_CANT_WRITE:
          $this
            ->buildViolation($constraint->uploadCantWriteErrorMessage)
            ->setCode(UPLOAD_ERR_CANT_WRITE)
            ->addViolation();
          return;
        case UPLOAD_ERR_EXTENSION:
          $this
            ->buildViolation($constraint->uploadExtensionErrorMessage)
            ->setCode(UPLOAD_ERR_EXTENSION)
            ->addViolation();
          return;
        default:
          $this
            ->buildViolation($constraint->uploadErrorMessage)
            ->setCode($value
            ->getError())
            ->addViolation();
          return;
      }
    }
    if (!is_scalar($value) && !$value instanceof FileObject && !(is_object($value) && method_exists($value, '__toString'))) {
      throw new UnexpectedTypeException($value, 'string');
    }
    $path = $value instanceof FileObject ? $value
      ->getPathname() : (string) $value;
    if (!is_file($path)) {
      $this
        ->buildViolation($constraint->notFoundMessage)
        ->setParameter('{{ file }}', $this
        ->formatValue($path))
        ->setCode(File::NOT_FOUND_ERROR)
        ->addViolation();
      return;
    }
    if (!is_readable($path)) {
      $this
        ->buildViolation($constraint->notReadableMessage)
        ->setParameter('{{ file }}', $this
        ->formatValue($path))
        ->setCode(File::NOT_READABLE_ERROR)
        ->addViolation();
      return;
    }
    $sizeInBytes = filesize($path);
    if (0 === $sizeInBytes) {
      $this
        ->buildViolation($constraint->disallowEmptyMessage)
        ->setParameter('{{ file }}', $this
        ->formatValue($path))
        ->setCode(File::EMPTY_ERROR)
        ->addViolation();
      return;
    }
    if ($constraint->maxSize) {
      $limitInBytes = $constraint->maxSize;
      if ($sizeInBytes > $limitInBytes) {
        list($sizeAsString, $limitAsString, $suffix) = $this
          ->factorizeSizes($sizeInBytes, $limitInBytes, $constraint->binaryFormat);
        $this
          ->buildViolation($constraint->maxSizeMessage)
          ->setParameter('{{ file }}', $this
          ->formatValue($path))
          ->setParameter('{{ size }}', $sizeAsString)
          ->setParameter('{{ limit }}', $limitAsString)
          ->setParameter('{{ suffix }}', $suffix)
          ->setCode(File::TOO_LARGE_ERROR)
          ->addViolation();
        return;
      }
    }
    if ($constraint->mimeTypes) {
      if (!$value instanceof FileObject) {
        $value = new FileObject($value);
      }
      $mimeTypes = (array) $constraint->mimeTypes;
      $mime = $value
        ->getMimeType();
      foreach ($mimeTypes as $mimeType) {
        if ($mimeType === $mime) {
          return;
        }
        if ($discrete = strstr($mimeType, '/*', true)) {
          if (strstr($mime, '/', true) === $discrete) {
            return;
          }
        }
      }
      $this
        ->buildViolation($constraint->mimeTypesMessage)
        ->setParameter('{{ file }}', $this
        ->formatValue($path))
        ->setParameter('{{ type }}', $this
        ->formatValue($mime))
        ->setParameter('{{ types }}', $this
        ->formatValues($mimeTypes))
        ->setCode(File::INVALID_MIME_TYPE_ERROR)
        ->addViolation();
    }
  }
  private static function moreDecimalsThan($double, $numberOfDecimals) {
    return strlen((string) $double) > strlen(round($double, $numberOfDecimals));
  }

  /**
   * Convert the limit to the smallest possible number
   * (i.e. try "MB", then "kB", then "bytes")
   */
  private function factorizeSizes($size, $limit, $binaryFormat) {
    if ($binaryFormat) {
      $coef = self::MIB_BYTES;
      $coefFactor = self::KIB_BYTES;
    }
    else {
      $coef = self::MB_BYTES;
      $coefFactor = self::KB_BYTES;
    }
    $limitAsString = (string) ($limit / $coef);

    // Restrict the limit to 2 decimals (without rounding! we
    // need the precise value)
    while (self::moreDecimalsThan($limitAsString, 2)) {
      $coef /= $coefFactor;
      $limitAsString = (string) ($limit / $coef);
    }

    // Convert size to the same measure, but round to 2 decimals
    $sizeAsString = (string) round($size / $coef, 2);

    // If the size and limit produce the same string output
    // (due to rounding), reduce the coefficient
    while ($sizeAsString === $limitAsString) {
      $coef /= $coefFactor;
      $limitAsString = (string) ($limit / $coef);
      $sizeAsString = (string) round($size / $coef, 2);
    }
    return array(
      $sizeAsString,
      $limitAsString,
      self::$suffices[$coef],
    );
  }

}

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
FileValidator::validate	public	function	Checks if the passed value is valid. Overrides ConstraintValidatorInterface::validate	1

You are here

class FileValidator in Plug 7

Hierarchy

File

Namespace

Members

API Navigation