feat: add background color option

Author: ace-of-aces

config/image-transform-url.php

@@ -43,6 +43,7 @@
         'flip',
         'contrast',
         'version',
+        'background',
         // 'blur'
     ]),
 

src/Enums/AllowedOptions.php

@@ -14,6 +14,7 @@ enum AllowedOptions: string
     case Contrast = 'contrast';
     case Flip = 'flip';
     case Version = 'version';
+    case Background = 'background';
 
     public static function all(): array
     {
@@ -31,6 +32,7 @@ public static function withTypes(): array
             self::Contrast->value => 'integer',
             self::Flip->value => 'string',
             self::Version->value => 'integer',
+            self::Background->value => 'string',
         ];
     }
 }

src/Http/Controllers/ImageTransformerController.php

@@ -94,6 +94,19 @@ public function __invoke(Request $request, string $options, string $path)
             };
         }
 
+        if (Arr::has($options, 'background')) {
+            $backgroundColor = $this->getStringOptionValue($options, 'background', 'ffffff');
+
+            if (! preg_match('/^([a-f0-9]{6}|[a-f0-9]{3})$/', $backgroundColor)) {
+                $backgroundColor = null;
+            }
+
+            if ($backgroundColor) {
+                $image->blendTransparency($backgroundColor);
+            }
+
+        }
+
         // We use the mime type instead of the extension to determine the format, because this is more reliable.
         $originalMimetype = File::mimeType($publicPath);
 

tests/Feature/OptionsTest.php

@@ -3,6 +3,8 @@
 declare(strict_types=1);
 
 use AceOfAces\LaravelImageTransformUrl\Tests\TestCase;
+use Illuminate\Support\Facades\Cache;
+use Illuminate\Support\Facades\Storage;
 
 beforeEach(function () {
     Cache::flush();
@@ -94,6 +96,18 @@
     ]);
 });
 
+it('can process the background option', function () {
+    /** @var TestCase $this */
+    $response = $this->get(route('image.transform', [
+        'options' => 'background=ffaa00',
+        'path' => 'octocat.png',
+    ]));
+
+    expect($response)->toBeImage([
+        'mime' => 'image/png',
+    ]);
+});
+
 it('can process multiple options at once', function () {
     /** @var TestCase $this */
     $response = $this->get(route('image.transform', [