vendor/vich/uploader-bundle/src/Handler/UploadHandler.php line 53

Open in your IDE?
  1. <?php
  3. namespace Vich\UploaderBundle\Handler;
  5. use Symfony\Component\HttpFoundation\File\UploadedFile;
  6. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  7. use Vich\UploaderBundle\Event\Event;
  8. use Vich\UploaderBundle\Event\Events;
  9. use Vich\UploaderBundle\FileAbstraction\ReplacingFile;
  10. use Vich\UploaderBundle\Injector\FileInjectorInterface;
  11. use Vich\UploaderBundle\Mapping\PropertyMapping;
  12. use Vich\UploaderBundle\Mapping\PropertyMappingFactory;
  13. use Vich\UploaderBundle\Storage\StorageInterface;
  15. /**
  16.  * Upload handler.
  17.  *
  18.  * @author Kévin Gomez <contact@kevingomez.fr>
  19.  * @final
  20.  */
  21. class UploadHandler extends AbstractHandler
  22. {
  23.     /**
  24.      * @var FileInjectorInterface
  25.      */
  26.     protected $injector;
  28.     /**
  29.      * @var EventDispatcherInterface
  30.      */
  31.     protected $dispatcher;
  33.     public function __construct(
  34.         PropertyMappingFactory $factory,
  35.         StorageInterface $storage,
  36.         FileInjectorInterface $injector,
  37.         EventDispatcherInterface $dispatcher
  38.     ) {
  39.         parent::__construct($factory, $storage);
  41.         $this->injector = $injector;
  42.         $this->dispatcher = $dispatcher;
  43.     }
  45.     /**
  46.      * Checks for file to upload.
  47.      *
  48.      * @param object $obj       The object
  49.      * @param string $fieldName The name of the field containing the upload (has to be mapped)
  50.      *
  51.      * @throws \Vich\UploaderBundle\Exception\MappingNotFoundException
  52.      */
  53.     public function upload($obj, string $fieldName): void
  54.     {
  55.         $mapping = $this->getMapping($obj, $fieldName);
  57.         // nothing to upload
  58.         if (!$this->hasUploadedFile($obj, $mapping)) {
  59.             return;
  60.         }
  62.         $this->dispatch(Events::PRE_UPLOAD, new Event($obj, $mapping));
  64.         $this->storage->upload($obj, $mapping);
  65.         $this->injector->injectFile($obj, $mapping);
  67.         $this->dispatch(Events::POST_UPLOAD, new Event($obj, $mapping));
  68.     }
  70.     public function inject($obj, string $fieldName): void
  71.     {
  72.         $mapping = $this->getMapping($obj, $fieldName);
  74.         $this->dispatch(Events::PRE_INJECT, new Event($obj, $mapping));
  76.         $this->injector->injectFile($obj, $mapping);
  78.         $this->dispatch(Events::POST_INJECT, new Event($obj, $mapping));
  79.     }
  81.     public function clean($obj, string $fieldName): void
  82.     {
  83.         $mapping = $this->getMapping($obj, $fieldName);
  85.         // nothing uploaded, do not remove anything
  86.         if (!$this->hasUploadedFile($obj, $mapping)) {
  87.             return;
  88.         }
  90.         $this->remove($obj, $fieldName);
  91.     }
  93.     public function remove($obj, string $fieldName): void
  94.     {
  95.         $mapping = $this->getMapping($obj, $fieldName);
  96.         $oldFilename = $mapping->getFileName($obj);
  98.         // nothing to remove, avoid dispatching useless events
  99.         if (empty($oldFilename)) {
  100.             return;
  101.         }
  103.         $preEvent = new Event($obj, $mapping);
  105.         $this->dispatch(Events::PRE_REMOVE, $preEvent);
  107.         if ($preEvent->isCanceled()) {
  108.             return;
  109.         }
  111.         $this->storage->remove($obj, $mapping);
  112.         $mapping->erase($obj);
  114.         $this->dispatch(Events::POST_REMOVE, new Event($obj, $mapping));
  115.     }
  117.     protected function dispatch(string $eventName, Event $event): void
  118.     {
  119.         $this->dispatcher->dispatch($event, $eventName);
  120.     }
  122.     protected function hasUploadedFile(object $obj, PropertyMapping $mapping): bool
  123.     {
  124.         $file = $mapping->getFile($obj);
  126.         return $file instanceof UploadedFile || $file instanceof ReplacingFile;
  127.     }
  128. }