Introduce UntranslatableMessage instead

VincentLanglet · VincentLanglet · commit cdd516b08f44 · 2025-06-29T22:49:39.000+02:00
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -4,7 +4,7 @@ CHANGELOG
 7.4
 ---
 
-* Allow to use false as domain for `Symfony\Component\Translation\TranslatableMessage`
+* Introduce `Symfony\Component\Translation\UntranslatableMessage`
 
 7.3
 ---
diff --git a/src/Symfony/Component/Translation/Tests/TranslatableTest.php b/src/Symfony/Component/Translation/Tests/TranslatableTest.php
@@ -53,9 +53,6 @@ public static function getTransTests()
             ['Symfony est super !', new TranslatableMessage('Symfony is great!', [], ''), [
                 'Symfony is great!' => 'Symfony est super !',
             ], 'fr'],
-            ['Symfony is great!', new TranslatableMessage('Symfony is great!', [], false), [
-                'Symfony is great!' => 'Symfony est super !',
-            ], 'fr'],
             ['Symfony est awesome !', new TranslatableMessage('Symfony is %what%!', ['%what%' => 'awesome'], ''), [
                 'Symfony is %what%!' => 'Symfony est %what% !',
             ], 'fr'],
diff --git a/src/Symfony/Component/Translation/Tests/UntranslatableTest.php b/src/Symfony/Component/Translation/Tests/UntranslatableTest.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation\Tests;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Translation\Loader\ArrayLoader;
+use Symfony\Component\Translation\Translator;
+use Symfony\Component\Translation\UntranslatableMessage;
+
+class UntranslatableTest extends TestCase
+{
+    public function testTrans()
+    {
+        $translator = new Translator('en');
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', [
+            'Symfony is great!' => 'Symfony est super !',
+        ], 'fr', '');
+
+        $translatable = new UntranslatableMessage('Symfony is great!');
+
+        $this->assertSame('Symfony is great!', $translatable->trans($translator, 'fr'));
+    }
+
+    public function testToString()
+    {
+        $this->assertSame('Symfony is great!', (string) new UntranslatableMessage('Symfony is great!'));
+    }
+}
diff --git a/src/Symfony/Component/Translation/TranslatableMessage.php b/src/Symfony/Component/Translation/TranslatableMessage.php
@@ -22,7 +22,7 @@ class TranslatableMessage implements TranslatableInterface
     public function __construct(
         private string $message,
         private array $parameters = [],
-        private string|false|null $domain = null,
+        private ?string $domain = null,
     ) {
     }
 
@@ -41,17 +41,13 @@ public function getParameters(): array
         return $this->parameters;
     }
 
-    public function getDomain(): string|false|null
+    public function getDomain(): ?string
     {
         return $this->domain;
     }
 
     public function trans(TranslatorInterface $translator, ?string $locale = null): string
     {
-        if (false === $this->getDomain()) {
-            return $this->getMessage();
-        }
-
         return $translator->trans($this->getMessage(), array_map(
             static fn ($parameter) => $parameter instanceof TranslatableInterface ? $parameter->trans($translator, $locale) : $parameter,
             $this->getParameters()
diff --git a/src/Symfony/Component/Translation/UntranslatableMessage.php b/src/Symfony/Component/Translation/UntranslatableMessage.php
@@ -0,0 +1,38 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Translation;
+
+use Symfony\Contracts\Translation\TranslatableInterface;
+use Symfony\Contracts\Translation\TranslatorInterface;
+
+class UntranslatableMessage implements TranslatableInterface
+{
+    public function __construct(
+        private string $message,
+    ) {
+    }
+
+    public function __toString(): string
+    {
+        return $this->getMessage();
+    }
+
+    public function getMessage(): string
+    {
+        return $this->message;
+    }
+
+    public function trans(TranslatorInterface $translator, ?string $locale = null): string
+    {
+        return $this->getMessage();
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ class TranslatableMessage implements TranslatableInterface`
`22`	`22`	`public function __construct(`
`23`	`23`	`private string $message,`
`24`	`24`	`private array $parameters = [],`
`25`		`- private string\|false\|null $domain = null,`
	`25`	`+ private ?string $domain = null,`
`26`	`26`	`) {`
`27`	`27`	`}`
`28`	`28`
`@@ -41,17 +41,13 @@ public function getParameters(): array`
`41`	`41`	`return $this->parameters;`
`42`	`42`	`}`
`43`	`43`
`44`		`- public function getDomain(): string\|false\|null`
	`44`	`+ public function getDomain(): ?string`
`45`	`45`	`{`
`46`	`46`	`return $this->domain;`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`public function trans(TranslatorInterface $translator, ?string $locale = null): string`
`50`	`50`	`{`
`51`		`- if (false === $this->getDomain()) {`
`52`		`- return $this->getMessage();`
`53`		`- }`
`54`		`-`
`55`	`51`	`return $translator->trans($this->getMessage(), array_map(`
`56`	`52`	`static fn ($parameter) => $parameter instanceof TranslatableInterface ? $parameter->trans($translator, $locale) : $parameter,`
`57`	`53`	`$this->getParameters()`