vendor/symfony/validator/Constraints/File.php line 26

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Validator\Constraints;
  14. use Symfony\Component\Validator\Constraint;
  15. use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
  17. /**
  18.  * @Annotation
  19.  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  20.  *
  21.  * @property int $maxSize
  22.  *
  23.  * @author Bernhard Schussek <bschussek@gmail.com>
  24.  */
  25. #[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
  26. class File extends Constraint
  27. {
  28.     // Check the Image constraint for clashes if adding new constants here
  30.     public const NOT_FOUND_ERROR = 'd2a3fb6e-7ddc-4210-8fbf-2ab345ce1998';
  31.     public const NOT_READABLE_ERROR = 'c20c92a4-5bfa-4202-9477-28e800e0f6ff';
  32.     public const EMPTY_ERROR = '5d743385-9775-4aa5-8ff5-495fb1e60137';
  33.     public const TOO_LARGE_ERROR = 'df8637af-d466-48c6-a59d-e7126250a654';
  34.     public const INVALID_MIME_TYPE_ERROR = '744f00bc-4389-4c74-92de-9a43cde55534';
  36.     protected static $errorNames = [
  37.         self::NOT_FOUND_ERROR => 'NOT_FOUND_ERROR',
  38.         self::NOT_READABLE_ERROR => 'NOT_READABLE_ERROR',
  39.         self::EMPTY_ERROR => 'EMPTY_ERROR',
  40.         self::TOO_LARGE_ERROR => 'TOO_LARGE_ERROR',
  41.         self::INVALID_MIME_TYPE_ERROR => 'INVALID_MIME_TYPE_ERROR',
  42.     ];
  44.     public $binaryFormat;
  45.     public $mimeTypes = [];
  46.     public $notFoundMessage = 'The file could not be found.';
  47.     public $notReadableMessage = 'The file is not readable.';
  48.     public $maxSizeMessage = 'The file is too large ({{ size }} {{ suffix }}). Allowed maximum size is {{ limit }} {{ suffix }}.';
  49.     public $mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';
  50.     public $disallowEmptyMessage = 'An empty file is not allowed.';
  52.     public $uploadIniSizeErrorMessage = 'The file is too large. Allowed maximum size is {{ limit }} {{ suffix }}.';
  53.     public $uploadFormSizeErrorMessage = 'The file is too large.';
  54.     public $uploadPartialErrorMessage = 'The file was only partially uploaded.';
  55.     public $uploadNoFileErrorMessage = 'No file was uploaded.';
  56.     public $uploadNoTmpDirErrorMessage = 'No temporary folder was configured in php.ini.';
  57.     public $uploadCantWriteErrorMessage = 'Cannot write temporary file to disk.';
  58.     public $uploadExtensionErrorMessage = 'A PHP extension caused the upload to fail.';
  59.     public $uploadErrorMessage = 'The file could not be uploaded.';
  61.     protected $maxSize;
  63.     /**
  64.      * {@inheritdoc}
  65.      *
  66.      * @param int|string|null      $maxSize
  67.      * @param string[]|string|null $mimeTypes
  68.      */
  69.     public function __construct(
  70.         array $options = null,
  71.         $maxSize = null,
  72.         bool $binaryFormat = null,
  73.         $mimeTypes = null,
  74.         string $notFoundMessage = null,
  75.         string $notReadableMessage = null,
  76.         string $maxSizeMessage = null,
  77.         string $mimeTypesMessage = null,
  78.         string $disallowEmptyMessage = null,
  80.         string $uploadIniSizeErrorMessage = null,
  81.         string $uploadFormSizeErrorMessage = null,
  82.         string $uploadPartialErrorMessage = null,
  83.         string $uploadNoFileErrorMessage = null,
  84.         string $uploadNoTmpDirErrorMessage = null,
  85.         string $uploadCantWriteErrorMessage = null,
  86.         string $uploadExtensionErrorMessage = null,
  87.         string $uploadErrorMessage = null,
  88.         array $groups = null,
  89.         $payload = null
  90.     ) {
  91.         if (null !== $maxSize && !\is_int($maxSize) && !\is_string($maxSize)) {
  92.             throw new \TypeError(sprintf('"%s": Expected argument $maxSize to be either null, an integer or a string, got "%s".', __METHOD__, get_debug_type($maxSize)));
  93.         }
  94.         if (null !== $mimeTypes && !\is_array($mimeTypes) && !\is_string($mimeTypes)) {
  95.             throw new \TypeError(sprintf('"%s": Expected argument $mimeTypes to be either null, an array or a string, got "%s".', __METHOD__, get_debug_type($mimeTypes)));
  96.         }
  98.         parent::__construct($options, $groups, $payload);
  100.         $this->maxSize = $maxSize ?? $this->maxSize;
  101.         $this->binaryFormat = $binaryFormat ?? $this->binaryFormat;
  102.         $this->mimeTypes = $mimeTypes ?? $this->mimeTypes;
  103.         $this->notFoundMessage = $notFoundMessage ?? $this->notFoundMessage;
  104.         $this->notReadableMessage = $notReadableMessage ?? $this->notReadableMessage;
  105.         $this->maxSizeMessage = $maxSizeMessage ?? $this->maxSizeMessage;
  106.         $this->mimeTypesMessage = $mimeTypesMessage ?? $this->mimeTypesMessage;
  107.         $this->disallowEmptyMessage = $disallowEmptyMessage ?? $this->disallowEmptyMessage;
  108.         $this->uploadIniSizeErrorMessage = $uploadIniSizeErrorMessage ?? $this->uploadIniSizeErrorMessage;
  109.         $this->uploadFormSizeErrorMessage = $uploadFormSizeErrorMessage ?? $this->uploadFormSizeErrorMessage;
  110.         $this->uploadPartialErrorMessage = $uploadPartialErrorMessage ?? $this->uploadPartialErrorMessage;
  111.         $this->uploadNoFileErrorMessage = $uploadNoFileErrorMessage ?? $this->uploadNoFileErrorMessage;
  112.         $this->uploadNoTmpDirErrorMessage = $uploadNoTmpDirErrorMessage ?? $this->uploadNoTmpDirErrorMessage;
  113.         $this->uploadCantWriteErrorMessage = $uploadCantWriteErrorMessage ?? $this->uploadCantWriteErrorMessage;
  114.         $this->uploadExtensionErrorMessage = $uploadExtensionErrorMessage ?? $this->uploadExtensionErrorMessage;
  115.         $this->uploadErrorMessage = $uploadErrorMessage ?? $this->uploadErrorMessage;
  117.         if (null !== $this->maxSize) {
  118.             $this->normalizeBinaryFormat($this->maxSize);
  119.         }
  120.     }
  122.     public function __set(string $option, $value)
  123.     {
  124.         if ('maxSize' === $option) {
  125.             $this->normalizeBinaryFormat($value);
  127.             return;
  128.         }
  130.         parent::__set($option, $value);
  131.     }
  133.     public function __get(string $option)
  134.     {
  135.         if ('maxSize' === $option) {
  136.             return $this->maxSize;
  137.         }
  139.         return parent::__get($option);
  140.     }
  142.     public function __isset(string $option)
  143.     {
  144.         if ('maxSize' === $option) {
  145.             return true;
  146.         }
  148.         return parent::__isset($option);
  149.     }
  151.     /**
  152.      * @param int|string $maxSize
  153.      */
  154.     private function normalizeBinaryFormat($maxSize)
  155.     {
  156.         $factors = [
  157.             'k' => 1000,
  158.             'ki' => 1 << 10,
  159.             'm' => 1000 * 1000,
  160.             'mi' => 1 << 20,
  161.             'g' => 1000 * 1000 * 1000,
  162.             'gi' => 1 << 30,
  163.         ];
  164.         if (ctype_digit((string) $maxSize)) {
  165.             $this->maxSize = (int) $maxSize;
  166.             $this->binaryFormat = $this->binaryFormat ?? false;
  167.         } elseif (preg_match('/^(\d++)('.implode('|', array_keys($factors)).')$/i', $maxSize, $matches)) {
  168.             $this->maxSize = $matches[1] * $factors[$unit = strtolower($matches[2])];
  169.             $this->binaryFormat = $this->binaryFormat ?? (2 === \strlen($unit));
  170.         } else {
  171.             throw new ConstraintDefinitionException(sprintf('"%s" is not a valid maximum size.', $maxSize));
  172.         }
  173.     }
  174. }