vendor/vich/uploader-bundle/src/Storage/AbstractStorage.php line 128

Open in your IDE?
  1. <?php
  3. namespace Vich\UploaderBundle\Storage;
  5. use Symfony\Component\HttpFoundation\File\UploadedFile;
  6. use Vich\UploaderBundle\Exception\MappingNotFoundException;
  7. use Vich\UploaderBundle\Mapping\PropertyMapping;
  8. use Vich\UploaderBundle\Mapping\PropertyMappingFactory;
  10. /**
  11.  * FileSystemStorage.
  12.  *
  13.  * @author Dustin Dobervich <ddobervich@gmail.com>
  14.  */
  15. abstract class AbstractStorage implements StorageInterface
  16. {
  17.     /**
  18.      * @var PropertyMappingFactory
  19.      */
  20.     protected $factory;
  22.     public function __construct(PropertyMappingFactory $factory)
  23.     {
  24.         $this->factory = $factory;
  25.     }
  27.     /**
  28.      * @return mixed
  29.      */
  30.     abstract protected function doUpload(PropertyMapping $mapping, UploadedFile $file, ?string $dir, string $name);
  32.     public function upload($obj, PropertyMapping $mapping): void
  33.     {
  34.         $file = $mapping->getFile($obj);
  36.         if (null === $file || !($file instanceof UploadedFile)) {
  37.             throw new \LogicException('No uploadable file found');
  38.         }
  40.         $name = $mapping->getUploadName($obj);
  41.         $mapping->setFileName($obj, $name);
  42.         $mimeType = $file->getMimeType();
  44.         $mapping->writeProperty($obj, 'size', $file->getSize());
  45.         $mapping->writeProperty($obj, 'mimeType', $mimeType);
  46.         $mapping->writeProperty($obj, 'originalName', $file->getClientOriginalName());
  48.         if (false !== \strpos($mimeType, 'image/') && 'image/svg+xml' !== $mimeType && false !== $dimensions = @\getimagesize($file)) {
  49.             $mapping->writeProperty($obj, 'dimensions', \array_splice($dimensions, 0, 2));
  50.         }
  52.         $dir = $mapping->getUploadDir($obj);
  54.         $this->doUpload($mapping, $file, $dir, $name);
  55.     }
  57.     abstract protected function doRemove(PropertyMapping $mapping, ?string $dir, string $name): ?bool;
  59.     public function remove($obj, PropertyMapping $mapping): ?bool
  60.     {
  61.         $name = $mapping->getFileName($obj);
  63.         if (empty($name)) {
  64.             return false;
  65.         }
  67.         return $this->doRemove($mapping, $mapping->getUploadDir($obj), $name);
  68.     }
  70.     /**
  71.      * Do resolve path.
  72.      *
  73.      * @param PropertyMapping $mapping  The mapping representing the field
  74.      * @param string|null     $dir      The directory in which the file is uploaded
  75.      * @param string          $name     The file name
  76.      * @param bool            $relative Whether the path should be relative or absolute
  77.      */
  78.     abstract protected function doResolvePath(PropertyMapping $mapping, ?string $dir, string $name, ?bool $relative = false): string;
  80.     public function resolvePath($obj, ?string $fieldName = null, ?string $className = null, ?bool $relative = false): ?string
  81.     {
  82.         [$mapping, $filename] = $this->getFilename($obj, $fieldName, $className);
  84.         if (empty($filename)) {
  85.             return null;
  86.         }
  88.         return $this->doResolvePath($mapping, $mapping->getUploadDir($obj), $filename, $relative);
  89.     }
  91.     public function resolveUri($obj, ?string $fieldName = null, ?string $className = null): ?string
  92.     {
  93.         [$mapping, $filename] = $this->getFilename($obj, $fieldName, $className);
  95.         if (empty($filename)) {
  96.             return null;
  97.         }
  99.         $dir = $mapping->getUploadDir($obj);
  100.         $path = !empty($dir) ? $dir.'/'.$filename : $filename;
  102.         return $mapping->getUriPrefix().'/'.$path;
  103.     }
  105.     public function resolveStream($obj, string $fieldName, ?string $className = null)
  106.     {
  107.         $path = $this->resolvePath($obj, $fieldName, $className);
  109.         if (empty($path)) {
  110.             return null;
  111.         }
  113.         return \fopen($path, 'rb');
  114.     }
  116.     /**
  117.      * note: extension point.
  118.      *
  119.      * @param object $obj
  120.      *
  121.      * @throws MappingNotFoundException
  122.      * @throws \RuntimeException
  123.      * @throws \Vich\UploaderBundle\Exception\NotUploadableException
  124.      */
  125.     protected function getFilename($obj, ?string $fieldName = null, ?string $className = null): array
  126.     {
  127.         $mapping = null === $fieldName ?
  128.             $this->factory->fromFirstField($obj, $className) :
  129.             $this->factory->fromField($obj, $fieldName, $className)
  130.         ;
  132.         if (null === $mapping) {
  133.             throw new MappingNotFoundException(\sprintf('Mapping not found for field "%s"', $fieldName));
  134.         }
  136.         return [$mapping, $mapping->getFileName($obj)];
  137.     }
  138. }