Merge pull request #180 from next-sentence/file-storage

Add FileUploaderInterface
monsieurbiz · Apr 6, 2022 · eb07151 · eb07151
2 parents d8499a8 + 2c43ba5
commit eb07151
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 5 deletions.
diff --git a/src/Controller/FormController.php b/src/Controller/FormController.php
@@ -15,7 +15,7 @@
 
 use MonsieurBiz\SyliusRichEditorPlugin\Exception\UiElementNotFoundException;
 use MonsieurBiz\SyliusRichEditorPlugin\UiElement\RegistryInterface;
-use MonsieurBiz\SyliusRichEditorPlugin\Uploader\FileUploader;
+use MonsieurBiz\SyliusRichEditorPlugin\Uploader\FileUploaderInterface;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\Form\Extension\Core\Type\FileType as NativeFileType;
 use Symfony\Component\Form\FormInterface;
@@ -122,7 +122,7 @@ public function renderElementsAction(Request $request): Response
     /**
      * Validate submitted data and return an UI Element JSON if everything is OK.
      */
-    public function submitAction(Request $request, FileUploader $fileUploader, string $code, bool $isEdition): Response
+    public function submitAction(Request $request, FileUploaderInterface $fileUploader, string $code, bool $isEdition): Response
     {
         // Find UI Element from type
         try {
@@ -181,7 +181,7 @@ public function submitAction(Request $request, FileUploader $fileUploader, strin
      *
      * @return array|mixed|string
      */
-    private function processFormData(FormInterface $form, FileUploader $fileUploader, $requestData)
+    private function processFormData(FormInterface $form, FileUploaderInterface $fileUploader, $requestData)
     {
         // No child, end of recursivity, return form value or uploaded file path
         if (!\count($form->all())) {
@@ -202,7 +202,7 @@ private function processFormData(FormInterface $form, FileUploader $fileUploader
      *
      * @return array|mixed|string
      */
-    private function processFormDataWithoutChild(FormInterface $form, FileUploader $fileUploader, $requestData)
+    private function processFormDataWithoutChild(FormInterface $form, FileUploaderInterface $fileUploader, $requestData)
     {
         if ($form->isValid() && $form->getData() instanceof UploadedFile) {
             // Upload image selected by user

diff --git a/src/Resources/config/services.yaml b/src/Resources/config/services.yaml
@@ -38,3 +38,5 @@ services:
             $fileTargetPath: '%monsieurbiz.richeditor.config.upload_directory%'
             $imageTargetPath: '%monsieurbiz.richeditor.config.image_upload_directory%'
             $publicDirectory: '%kernel.project_dir%/public'
+
+    MonsieurBiz\SyliusRichEditorPlugin\Uploader\FileUploaderInterface: '@MonsieurBiz\SyliusRichEditorPlugin\Uploader\FileUploader'
diff --git a/src/Uploader/FileUploader.php b/src/Uploader/FileUploader.php
@@ -17,7 +17,7 @@
 use Symfony\Component\HttpFoundation\File\File;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
-class FileUploader
+class FileUploader implements FileUploaderInterface
 {
     public const FILE_TYPE_DOCUMENT = 'document';
 

diff --git a/src/Uploader/FileUploaderInterface.php b/src/Uploader/FileUploaderInterface.php
@@ -0,0 +1,24 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Rich Editor plugin for Sylius.
+ *
+ * (c) Monsieur Biz <sylius@monsieurbiz.com>
+ *
+ * For the full copyright and license information, please view the LICENSE.txt
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusRichEditorPlugin\Uploader;
+
+use Symfony\Component\HttpFoundation\File\UploadedFile;
+
+interface FileUploaderInterface
+{
+    /**
+     * Upload a file and return the path to it.
+     */
+    public function upload(UploadedFile $file, ?string $type = null): string;
+}