Add Image::toMediaType()

Intervention · Dec 17, 2023 · 04faec2 · 04faec2
1 parent b12f31e
commit 04faec2
Show file tree

Hide file tree

Showing 6 changed files with 104 additions and 11 deletions.
diff --git a/src/Encoders/AutoEncoder.php b/src/Encoders/AutoEncoder.php
@@ -9,20 +9,38 @@
 
 class AutoEncoder implements EncoderInterface
 {
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
     public function encode(ImageInterface $image): EncodedImageInterface
     {
-        $type = $image->origin()->mediaType();
         return $image->encode(
-            match ($type) {
-                'image/webp' => new WebpEncoder(),
-                'image/avif' => new AvifEncoder(),
-                'image/jpeg' => new JpegEncoder(),
-                'image/bmp' => new BmpEncoder(),
-                'image/gif' => new GifEncoder(),
-                'image/png' => new PngEncoder(),
-                'image/tiff' => new TiffEncoder(),
-                default => throw new EncoderException('No encoder found for media type (' . $type . ').'),
-            }
+            $this->encoderByMediaType(
+                $image->origin()->mediaType()
+            )
         );
     }
+
+    /**
+     * Return encoder matching to encode given media (mime) type
+     *
+     * @param string $type
+     * @return EncoderInterface
+     * @throws EncoderException
+     */
+    protected function encoderByMediaType(string $type): EncoderInterface
+    {
+        return match ($type) {
+            'image/webp' => new WebpEncoder(),
+            'image/avif' => new AvifEncoder(),
+            'image/jpeg' => new JpegEncoder(),
+            'image/bmp' => new BmpEncoder(),
+            'image/gif' => new GifEncoder(),
+            'image/png' => new PngEncoder(),
+            'image/tiff' => new TiffEncoder(),
+            default => throw new EncoderException('No encoder found for media type (' . $type . ').'),
+        };
+    }
 }
diff --git a/src/Encoders/MediaTypeEncoder.php b/src/Encoders/MediaTypeEncoder.php
@@ -0,0 +1,33 @@
+<?php
+
+namespace Intervention\Image\Encoders;
+
+use Intervention\Image\Interfaces\EncodedImageInterface;
+use Intervention\Image\Interfaces\ImageInterface;
+
+class MediaTypeEncoder extends AutoEncoder
+{
+    /**
+     * Create new encoder instance to encode given media (mime) type
+     *
+     * @param null|string $type
+     * @return void
+     */
+    public function __construct(protected ?string $type = null)
+    {
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @see EncoderInterface::encode()
+     */
+    public function encode(ImageInterface $image): EncodedImageInterface
+    {
+        return $image->encode(
+            $this->encoderByMediaType(
+                is_null($this->type) ? $image->origin()->mediaType() : $this->type
+            )
+        );
+    }
+}
diff --git a/src/Image.php b/src/Image.php
@@ -16,6 +16,7 @@
 use Intervention\Image\Encoders\BmpEncoder;
 use Intervention\Image\Encoders\GifEncoder;
 use Intervention\Image\Encoders\JpegEncoder;
+use Intervention\Image\Encoders\MediaTypeEncoder;
 use Intervention\Image\Encoders\PngEncoder;
 use Intervention\Image\Encoders\TiffEncoder;
 use Intervention\Image\Encoders\WebpEncoder;
@@ -744,6 +745,16 @@ public function drawLine(callable $init): ImageInterface
         );
     }
 
+    /**
+     * {@inheritdoc}
+     *
+     * @see ImageInterface::toMediaType()
+     */
+    public function toMediaType(?string $type = null): EncodedImageInterface
+    {
+        return $this->encode(new MediaTypeEncoder($type));
+    }
+
     /**
      * {@inheritdoc}
      *

diff --git a/src/Interfaces/ImageInterface.php b/src/Interfaces/ImageInterface.php
@@ -557,6 +557,15 @@ public function drawPolygon(callable $init): ImageInterface;
      */
     public function drawLine(callable $init): ImageInterface;
 
+    /**
+     * Encode image to given media (mime) type. If no type is given the image
+     * will be encoded to the format of the originally read image.
+     *
+     * @param null|string $type
+     * @return EncodedImageInterface
+     */
+    public function toMediaType(?string $type = null): EncodedImageInterface;
+
     /**
      * Encode image to JPEG format
      *

diff --git a/tests/Drivers/Gd/ImageTest.php b/tests/Drivers/Gd/ImageTest.php
@@ -122,6 +122,17 @@ public function testAutoEncode(): void
         $this->assertMediaType('image/gif', (string) $result);
     }
 
+    public function testToMediaType(): void
+    {
+        $result = $this->readTestImage('blue.gif')->toMediaType();
+        $this->assertInstanceOf(EncodedImage::class, $result);
+        $this->assertMediaType('image/gif', (string) $result);
+
+        $result = $this->readTestImage('blue.gif')->toMediaType('image/png');
+        $this->assertInstanceOf(EncodedImage::class, $result);
+        $this->assertMediaType('image/png', (string) $result);
+    }
+
     public function testWidthHeightSize(): void
     {
         $this->assertEquals(3, $this->image->width());

diff --git a/tests/Drivers/Imagick/ImageTest.php b/tests/Drivers/Imagick/ImageTest.php
@@ -121,6 +121,17 @@ public function testAutoEncode(): void
         $this->assertMediaType('image/gif', (string) $result);
     }
 
+    public function testToMediaType(): void
+    {
+        $result = $this->readTestImage('blue.gif')->toMediaType();
+        $this->assertInstanceOf(EncodedImage::class, $result);
+        $this->assertMediaType('image/gif', (string) $result);
+
+        $result = $this->readTestImage('blue.gif')->toMediaType('image/png');
+        $this->assertInstanceOf(EncodedImage::class, $result);
+        $this->assertMediaType('image/png', (string) $result);
+    }
+
     public function testWidthHeightSize(): void
     {
         $this->assertEquals(20, $this->image->width());