allow to set formatter for conversions

Author: QuentinGab

.gitignore

@@ -1,3 +1,4 @@
+**/.DS_Store
 .idea
 .phpunit.cache
 build
@@ -8,4 +9,4 @@ phpunit.xml
 phpstan.neon
 testbench.yaml
 vendor
-node_modules
+node_modules

src/Concerns/InteractWithFiles.php

@@ -10,6 +10,7 @@
 use Elegantly\Media\Enums\MediaType;
 use Elegantly\Media\Helpers\File;
 use Elegantly\Media\TemporaryDirectory;
+use Elegantly\Media\UrlFormatters\AbstractUrlFormatter;
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\File as HttpFile;
@@ -36,6 +37,17 @@
  */
 trait InteractWithFiles
 {
+    /**
+     * @return class-string<AbstractUrlFormatter>
+     */
+    public function getDefaultUrlFormatter(): string
+    {
+        /** @var class-string<AbstractUrlFormatter> */
+        $formatter = config()->string('media.default_url_formatter');
+
+        return $formatter;
+    }
+
     public function getDisk(): ?Filesystem
     {
         if (! $this->disk) {
@@ -45,13 +57,27 @@ public function getDisk(): ?Filesystem
         return Storage::disk($this->disk);
     }
 
-    public function getUrl(): ?string
-    {
+    /**
+     * @param  null|array<array-key, mixed>  $parameters
+     * @param  null|class-string<AbstractUrlFormatter>  $formatter
+     */
+    public function getUrl(
+        ?array $parameters = null,
+        ?string $formatter = null
+    ): ?string {
         if (! $this->path) {
             return null;
         }
 
-        return $this->getDisk()?->url($this->path);
+        $url = $this->getDisk()?->url($this->path);
+
+        if ($url) {
+            $formatter ??= $this->getDefaultUrlFormatter();
+
+            return (new $formatter)->format($url, $parameters);
+        }
+
+        return null;
     }
 
     /**

src/Models/Media.php

@@ -55,7 +55,9 @@ class Media extends Model
     use HasFactory;
 
     use HasUuid;
-    use InteractWithFiles;
+    use InteractWithFiles {
+        getUrl as traitGetUrl;
+    }
 
     /**
      * @var array<int, string>
@@ -643,22 +645,11 @@ public function getPath(
         return null;
     }
 
-    /**
-     * @return class-string<AbstractUrlFormatter>
-     */
-    public function getDefaultUrlFormatter(): string
-    {
-        /** @var class-string<AbstractUrlFormatter> */
-        $formatter = config()->string('media.default_url_formatter');
-
-        return $formatter;
-    }
-
     /**
      * Retreive the url of a conversion or nested conversion
      * Ex: $media->getUrl('poster.480p')
      *
-     * @param  null|bool|string|array<int, string>  $fallback
+     * @param  null|bool|string|array<int, string|bool>  $fallback
      * @param  null|array<array-key, mixed>  $parameters
      * @param  null|class-string<AbstractUrlFormatter>  $formatter
      */
@@ -668,20 +659,24 @@ public function getUrl(
         ?array $parameters = null,
         ?string $formatter = null
     ): ?string {
+
         $url = null;
 
         if ($conversion) {
-            $url = $this->getConversion($conversion)?->getUrl();
+            $url = $this->getConversion($conversion)?->getUrl(
+                parameters: $parameters,
+                formatter: $formatter,
+            );
         } elseif ($this->path) {
             /** @var null|string $url */
-            $url = $this->getDisk()?->url($this->path);
+            $url = $this->traitGetUrl(
+                parameters: $parameters,
+                formatter: $formatter
+            );
         }
 
         if ($url) {
-            $formatter ??= $this->getDefaultUrlFormatter();
-
-            return (new $formatter)->format($url, $parameters);
-
+            return $url;
         } elseif ($fallback === true) {
             return $this->getUrl(
                 parameters: $parameters,
@@ -692,11 +687,20 @@ public function getUrl(
                 parameters: $parameters
             ) ?? $fallback;
         } elseif (is_array($fallback)) {
-            return $this->getUrl(
-                conversion: array_shift($fallback),
-                fallback: $fallback,
-                parameters: $parameters
-            );
+            $fallbackValue = array_shift($fallback);
+
+            if ($fallbackValue === true) {
+                return $this->getUrl(
+                    parameters: $parameters
+                );
+            } elseif (is_string($fallbackValue)) {
+                return $this->getUrl(
+                    conversion: $fallbackValue,
+                    fallback: $fallback,
+                    parameters: $parameters
+                );
+            }
+
         }
 
         return null;

tests/Feature/MediaTest.php

@@ -7,6 +7,8 @@
 use Elegantly\Media\Models\Media;
 use Elegantly\Media\Models\MediaConversion;
 use Elegantly\Media\Tests\Models\Test;
+use Elegantly\Media\UrlFormatters\CloudflareImageUrlFormatter;
+use Elegantly\Media\UrlFormatters\CloudflareVideoUrlFormatter;
 use FFMpeg\Coordinate\Dimension;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Facades\Storage;
@@ -308,13 +310,36 @@
     $media = MediaFactory::new()->make();
 
     expect($media->getUrl())->toBe('/storage/{uuid}/empty.jpg');
+
+});
+
+it('retrieve the formatted url', function () {
+    /** @var Media $media */
+    $media = MediaFactory::new()->make();
+
     expect($media->getUrl(
         parameters: [
             'width' => 200,
             'height' => 200,
         ]
     ))->toBe('/storage/{uuid}/empty.jpg?width=200&height=200');
 
+    expect($media->getUrl(
+        parameters: [
+            'width' => 200,
+            'height' => 200,
+        ],
+        formatter: CloudflareImageUrlFormatter::class
+    ))->toBe('/cdn-cgi/image/width=200,height=200//storage/{uuid}/empty.jpg');
+
+    expect($media->getUrl(
+        parameters: [
+            'width' => 200,
+            'height' => 200,
+        ],
+        formatter: CloudflareVideoUrlFormatter::class
+    ))->toBe('/cdn-cgi/media/width=200,height=200//storage/{uuid}/empty.jpg');
+
 });
 
 it('retrieve the fallback url', function () {
@@ -331,6 +356,16 @@
         fallback: true,
     ))->toBe('/storage/{uuid}/empty.jpg');
 
+    expect($media->getUrl(
+        conversion: 'none',
+        fallback: ['none-2', true],
+    ))->toBe('/storage/{uuid}/empty.jpg');
+
+    expect($media->getUrl(
+        conversion: 'none',
+        fallback: ['none-2'],
+    ))->toBe(null);
+
     expect($media->getUrl(
         conversion: 'poster',
         fallback: true,
@@ -361,6 +396,11 @@
         ]
     ))->toBe('/storage/{uuid}/conversions/poster/poster.jpg?width=200&height=200');
 
+    expect($media->getUrl(
+        conversion: 'none',
+        fallback: ['poster'],
+    ))->toBe('/storage/{uuid}/conversions/poster/poster.jpg');
+
 });
 
 it('store a file within a prefixed path', function () {