[Validator] Improve Image constraint invalid mime type message

fancyweb · fancyweb · commit ef6be5e5ebe4 · 2022-02-24T16:28:44.000+01:00
diff --git a/src/Symfony/Component/Validator/Constraints/Image.php b/src/Symfony/Component/Validator/Constraints/Image.php
@@ -189,5 +189,9 @@ public function __construct(
         $this->allowLandscapeMessage = $allowLandscapeMessage ?? $this->allowLandscapeMessage;
         $this->allowPortraitMessage = $allowPortraitMessage ?? $this->allowPortraitMessage;
         $this->corruptedMessage = $corruptedMessage ?? $this->corruptedMessage;
+
+        if (!\in_array('image/*', (array) $this->mimeTypes, true) && !\array_key_exists('mimeTypesMessage', $options ?? []) && null === $mimeTypesMessage) {
+            $this->mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';
+        }
     }
 }
diff --git a/src/Symfony/Component/Validator/Tests/Constraints/ImageValidatorTest.php b/src/Symfony/Component/Validator/Tests/Constraints/ImageValidatorTest.php
@@ -546,4 +546,36 @@ public function provideDetectCorruptedConstraints(): iterable
             new Image(detectCorrupted: true, corruptedMessage: 'myMessage'),
         ];
     }
+
+    /**
+     * @dataProvider provideInvalidMimeTypeWithNarrowedSet
+     */
+    public function testInvalidMimeTypeWithNarrowedSet(Image $constraint)
+    {
+        $this->validator->validate($this->image, $constraint);
+
+        $this->buildViolation('The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.')
+            ->setParameter('{{ file }}', sprintf('"%s"', $this->image))
+            ->setParameter('{{ type }}', '"image/gif"')
+            ->setParameter('{{ types }}', '"image/jpeg", "image/png"')
+            ->setParameter('{{ name }}', '"test.gif"')
+            ->setCode(Image::INVALID_MIME_TYPE_ERROR)
+            ->assertRaised();
+    }
+
+    public function provideInvalidMimeTypeWithNarrowedSet()
+    {
+        yield 'Doctrine style' => [new Image([
+            'mimeTypes' => [
+                'image/jpeg',
+                'image/png',
+            ],
+        ])];
+        yield 'Named arguments' => [
+            new Image(mimeTypes: [
+                'image/jpeg',
+                'image/png',
+            ]),
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -189,5 +189,9 @@ public function __construct(`
`189`	`189`	`$this->allowLandscapeMessage = $allowLandscapeMessage ?? $this->allowLandscapeMessage;`
`190`	`190`	`$this->allowPortraitMessage = $allowPortraitMessage ?? $this->allowPortraitMessage;`
`191`	`191`	`$this->corruptedMessage = $corruptedMessage ?? $this->corruptedMessage;`
	`192`	`+`
	`193`	`+ if (!\in_array('image/*', (array) $this->mimeTypes, true) && !\array_key_exists('mimeTypesMessage', $options ?? []) && null === $mimeTypesMessage) {`
	`194`	`+ $this->mimeTypesMessage = 'The mime type of the file is invalid ({{ type }}). Allowed mime types are {{ types }}.';`
	`195`	`+ }`
`192`	`196`	`}`
`193`	`197`	`}`