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

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