Skip to content

Commit 33cbb21

Browse files
olivervogelolivervogel
authored
Filter out parameter that do not match target encoder (#1333)
Filter out parameters/options that are passed to a format-unspecific encoder like AutoEncoder::class or MediaTypeEncoder::class but are not available in the format specific target encoder.
1 parent 5464ca5 commit 33cbb21

File tree

3 files changed

+181
-99
lines changed

3 files changed

+181
-99
lines changed

‎src/Format.php

+32-11
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Intervention\Image\Encoders\WebpEncoder;
1717
use Intervention\Image\Exceptions\NotSupportedException;
1818
use Intervention\Image\Interfaces\EncoderInterface;
19+
use ReflectionClass;
1920

2021
enum Format
2122
{
@@ -88,23 +89,43 @@ public function fileExtensions(): array
8889
}
8990

9091
/**
91-
* Create an encoder instance that matches the format
92+
* Create an encoder instance with given options that matches the format
9293
*
9394
* @param mixed $options
9495
* @return EncoderInterface
9596
*/
9697
public function encoder(mixed ...$options): EncoderInterface
9798
{
98-
return match ($this) {
99-
self::AVIF => new AvifEncoder(...$options),
100-
self::BMP => new BmpEncoder(...$options),
101-
self::GIF => new GifEncoder(...$options),
102-
self::HEIC => new HeicEncoder(...$options),
103-
self::JP2 => new Jpeg2000Encoder(...$options),
104-
self::JPEG => new JpegEncoder(...$options),
105-
self::PNG => new PngEncoder(...$options),
106-
self::TIFF => new TiffEncoder(...$options),
107-
self::WEBP => new WebpEncoder(...$options),
99+
// get classname of target encoder from current format
100+
$classname = match ($this) {
101+
self::AVIF => AvifEncoder::class,
102+
self::BMP => BmpEncoder::class,
103+
self::GIF => GifEncoder::class,
104+
self::HEIC => HeicEncoder::class,
105+
self::JP2 => Jpeg2000Encoder::class,
106+
self::JPEG => JpegEncoder::class,
107+
self::PNG => PngEncoder::class,
108+
self::TIFF => TiffEncoder::class,
109+
self::WEBP => WebpEncoder::class,
108110
};
111+
112+
// get parameters of target encoder
113+
$parameters = [];
114+
$reflectionClass = new ReflectionClass($classname);
115+
if ($constructor = $reflectionClass->getConstructor()) {
116+
$parameters = array_map(
117+
fn ($parameter) => $parameter->getName(),
118+
$constructor->getParameters(),
119+
);
120+
}
121+
122+
// filter out unavailable options of target encoder
123+
$options = array_filter(
124+
$options,
125+
fn ($key) => in_array($key, $parameters),
126+
ARRAY_FILTER_USE_KEY,
127+
);
128+
129+
return new $classname(...$options);
109130
}
110131
}

‎tests/Unit/Encoders/FileExtensionEncoderTest.php

+50-88
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,19 @@
1818
use Intervention\Image\FileExtension;
1919
use Intervention\Image\Interfaces\EncoderInterface;
2020
use Intervention\Image\Tests\BaseTestCase;
21+
use PHPUnit\Framework\Attributes\DataProvider;
2122

2223
final class FileExtensionEncoderTest extends BaseTestCase
2324
{
24-
private function testEncoder(string|FileExtension $extension): EncoderInterface
25+
private function testEncoder(string|FileExtension $extension, array $options = []): EncoderInterface
2526
{
26-
$encoder = new class () extends FileExtensionEncoder
27+
$encoder = new class ($extension, ...$options) extends FileExtensionEncoder
2728
{
29+
public function __construct($mediaType, ...$options)
30+
{
31+
parent::__construct($mediaType, ...$options);
32+
}
33+
2834
public function test($extension)
2935
{
3036
return $this->encoderByFileExtension($extension);
@@ -34,100 +40,56 @@ public function test($extension)
3440
return $encoder->test($extension);
3541
}
3642

37-
public function testEncoderByFileExtensionString(): void
38-
{
39-
$this->assertInstanceOf(
40-
WebpEncoder::class,
41-
$this->testEncoder('webp')
42-
);
43-
43+
#[DataProvider('targetEncoderProvider')]
44+
public function testEncoderByFileExtensionString(
45+
string|FileExtension $fileExtension,
46+
string $targetEncoderClassname,
47+
): void {
4448
$this->assertInstanceOf(
45-
AvifEncoder::class,
46-
$this->testEncoder('avif')
47-
);
48-
49-
$this->assertInstanceOf(
50-
JpegEncoder::class,
51-
$this->testEncoder('jpeg')
52-
);
53-
54-
$this->assertInstanceOf(
55-
BmpEncoder::class,
56-
$this->testEncoder('bmp')
57-
);
58-
59-
$this->assertInstanceOf(
60-
GifEncoder::class,
61-
$this->testEncoder('gif')
62-
);
63-
64-
$this->assertInstanceOf(
65-
PngEncoder::class,
66-
$this->testEncoder('png')
67-
);
68-
69-
$this->assertInstanceOf(
70-
TiffEncoder::class,
71-
$this->testEncoder('tiff')
72-
);
73-
74-
$this->assertInstanceOf(
75-
Jpeg2000Encoder::class,
76-
$this->testEncoder('jp2')
77-
);
78-
79-
$this->assertInstanceOf(
80-
HeicEncoder::class,
81-
$this->testEncoder('heic')
49+
$targetEncoderClassname,
50+
$this->testEncoder($fileExtension),
8251
);
8352
}
8453

85-
public function testEncoderByFileExtensionEnumMember(): void
54+
public static function targetEncoderProvider(): array
8655
{
87-
$this->assertInstanceOf(
88-
WebpEncoder::class,
89-
$this->testEncoder(FileExtension::WEBP)
90-
);
91-
92-
$this->assertInstanceOf(
93-
AvifEncoder::class,
94-
$this->testEncoder(FileExtension::AVIF)
95-
);
96-
97-
$this->assertInstanceOf(
98-
JpegEncoder::class,
99-
$this->testEncoder(FileExtension::JPG)
100-
);
101-
102-
$this->assertInstanceOf(
103-
BmpEncoder::class,
104-
$this->testEncoder(FileExtension::BMP)
105-
);
106-
107-
$this->assertInstanceOf(
108-
GifEncoder::class,
109-
$this->testEncoder(FileExtension::GIF)
110-
);
111-
112-
$this->assertInstanceOf(
113-
PngEncoder::class,
114-
$this->testEncoder(FileExtension::PNG)
115-
);
116-
117-
$this->assertInstanceOf(
118-
TiffEncoder::class,
119-
$this->testEncoder(FileExtension::TIF)
120-
);
56+
return [
57+
['webp', WebpEncoder::class],
58+
['avif', AvifEncoder::class],
59+
['jpeg', JpegEncoder::class],
60+
['jpg', JpegEncoder::class],
61+
['bmp', BmpEncoder::class],
62+
['gif', GifEncoder::class],
63+
['png', PngEncoder::class],
64+
['tiff', TiffEncoder::class],
65+
['tif', TiffEncoder::class],
66+
['jp2', Jpeg2000Encoder::class],
67+
['heic', HeicEncoder::class],
68+
[FileExtension::WEBP, WebpEncoder::class],
69+
[FileExtension::AVIF, AvifEncoder::class],
70+
[FileExtension::JPG, JpegEncoder::class],
71+
[FileExtension::BMP, BmpEncoder::class],
72+
[FileExtension::GIF, GifEncoder::class],
73+
[FileExtension::PNG, PngEncoder::class],
74+
[FileExtension::TIF, TiffEncoder::class],
75+
[FileExtension::TIFF, TiffEncoder::class],
76+
[FileExtension::JP2, Jpeg2000Encoder::class],
77+
[FileExtension::HEIC, HeicEncoder::class],
78+
];
79+
}
12180

122-
$this->assertInstanceOf(
123-
Jpeg2000Encoder::class,
124-
$this->testEncoder(FileExtension::JPG2)
81+
public function testArgumentsNotSupportedByTargetEncoder(): void
82+
{
83+
$encoder = $this->testEncoder(
84+
'png',
85+
[
86+
'interlaced' => true, // is not ignored
87+
'quality' => 10, // is ignored because png encoder has no quality argument
88+
],
12589
);
12690

127-
$this->assertInstanceOf(
128-
HeicEncoder::class,
129-
$this->testEncoder(FileExtension::HEIC)
130-
);
91+
$this->assertInstanceOf(PngEncoder::class, $encoder);
92+
$this->assertTrue($encoder->interlaced);
13193
}
13294

13395
public function testEncoderByFileExtensionUnknown(): void

‎tests/Unit/Encoders/MediaTypeEncoderTest.php

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Intervention\Image\Tests\Unit\Encoders;
6+
7+
use Intervention\Image\Encoders\AvifEncoder;
8+
use Intervention\Image\Encoders\BmpEncoder;
9+
use Intervention\Image\Encoders\GifEncoder;
10+
use Intervention\Image\Encoders\HeicEncoder;
11+
use Intervention\Image\Encoders\Jpeg2000Encoder;
12+
use Intervention\Image\Encoders\JpegEncoder;
13+
use Intervention\Image\Encoders\MediaTypeEncoder;
14+
use Intervention\Image\Encoders\PngEncoder;
15+
use Intervention\Image\Encoders\TiffEncoder;
16+
use Intervention\Image\Encoders\WebpEncoder;
17+
use Intervention\Image\Exceptions\EncoderException;
18+
use Intervention\Image\Interfaces\EncoderInterface;
19+
use Intervention\Image\MediaType;
20+
use Intervention\Image\Tests\BaseTestCase;
21+
use PHPUnit\Framework\Attributes\DataProvider;
22+
23+
final class MediaTypeEncoderTest extends BaseTestCase
24+
{
25+
private function testEncoder(string|MediaType $mediaType, array $options = []): EncoderInterface
26+
{
27+
$encoder = new class ($mediaType, ...$options) extends MediaTypeEncoder
28+
{
29+
public function __construct($mediaType, ...$options)
30+
{
31+
parent::__construct($mediaType, ...$options);
32+
}
33+
34+
public function test($mediaType)
35+
{
36+
return $this->encoderByMediaType($mediaType);
37+
}
38+
};
39+
40+
return $encoder->test($mediaType);
41+
}
42+
43+
#[DataProvider('targetEncoderProvider')]
44+
public function testEncoderByMediaType(
45+
string|MediaType $mediaType,
46+
string $targetEncoderClassname,
47+
): void {
48+
$this->assertInstanceOf(
49+
$targetEncoderClassname,
50+
$this->testEncoder($mediaType)
51+
);
52+
}
53+
54+
public static function targetEncoderProvider(): array
55+
{
56+
return [
57+
['image/webp', WebpEncoder::class],
58+
['image/avif', AvifEncoder::class],
59+
['image/jpeg', JpegEncoder::class],
60+
['image/bmp', BmpEncoder::class],
61+
['image/gif', GifEncoder::class],
62+
['image/png', PngEncoder::class],
63+
['image/png', PngEncoder::class],
64+
['image/tiff', TiffEncoder::class],
65+
['image/jp2', Jpeg2000Encoder::class],
66+
['image/heic', HeicEncoder::class],
67+
[MediaType::IMAGE_WEBP, WebpEncoder::class],
68+
[MediaType::IMAGE_AVIF, AvifEncoder::class],
69+
[MediaType::IMAGE_JPEG, JpegEncoder::class],
70+
[MediaType::IMAGE_BMP, BmpEncoder::class],
71+
[MediaType::IMAGE_GIF, GifEncoder::class],
72+
[MediaType::IMAGE_PNG, PngEncoder::class],
73+
[MediaType::IMAGE_TIFF, TiffEncoder::class],
74+
[MediaType::IMAGE_JP2, Jpeg2000Encoder::class],
75+
[MediaType::IMAGE_HEIC, HeicEncoder::class],
76+
[MediaType::IMAGE_HEIF, HeicEncoder::class],
77+
];
78+
}
79+
80+
public function testArgumentsNotSupportedByTargetEncoder(): void
81+
{
82+
$encoder = $this->testEncoder(
83+
'image/png',
84+
[
85+
'interlaced' => true, // is not ignored
86+
'quality' => 10, // is ignored because png encoder has no quality argument
87+
],
88+
);
89+
90+
$this->assertInstanceOf(PngEncoder::class, $encoder);
91+
$this->assertTrue($encoder->interlaced);
92+
}
93+
94+
public function testEncoderByFileExtensionUnknown(): void
95+
{
96+
$this->expectException(EncoderException::class);
97+
$this->testEncoder('test');
98+
}
99+
}

0 commit comments

Comments
 (0)