Add Stringable type support for $id argument in Translator::translate() (#70)

xepozz · arogachev · vjik · web-flow · commit dd96cd12599b · 2022-10-21T08:59:59.000+03:00
* Add Stringable type to message

* Remove php 7.4 support

* Type cast was in a wrong place

* Add changelog entry

* PHPDoc - fix max line length, delete extra whitespace

* Fix CHANGELOG according to BC break

Co-authored-by: Alexey Rogachev &lt;arogachev90@gmail.com&gt;
Co-authored-by: Sergei Predvoditelev &lt;sergei@predvoditelev.ru&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,8 @@
 # Yii Message Translator Change Log
 
-## 1.1.2 under development
+## 2.0.0 under development
 
+- Enh #70: Add `Stringable` type support for `$id` argument in `Translator::translate()` (@xepozz)
 - Enh #74: Dispatch `MissingTranslationCategoryEvent` once per category (@vjik)
 - Enh #73: Set `en_US` as default locale for translator (@vjik)
 - Enh #72, #75: Format messages when missing translation category (@vjik)
diff --git a/src/Translator.php b/src/Translator.php
@@ -6,6 +6,7 @@
 
 use Psr\EventDispatcher\EventDispatcherInterface;
 use RuntimeException;
+use Stringable;
 use Yiisoft\I18n\Locale;
 use Yiisoft\Translator\Event\MissingTranslationCategoryEvent;
 use Yiisoft\Translator\Event\MissingTranslationEvent;
@@ -71,7 +72,7 @@ public function getLocale(): string
     }
 
     public function translate(
-        string $id,
+        string|Stringable $id,
         array $parameters = [],
         string $category = null,
         string $locale = null
@@ -82,10 +83,10 @@ public function translate(
 
         if (empty($this->categorySources[$category])) {
             $this->dispatchMissingTranslationCategoryEvent($category);
-            return $this->defaultMessageFormatter->format($id, $parameters, $locale);
+            return $this->defaultMessageFormatter->format((string) $id, $parameters, $locale);
         }
 
-        return $this->translateUsingCategorySources($id, $parameters, $category, $locale);
+        return $this->translateUsingCategorySources((string) $id, $parameters, $category, $locale);
     }
 
     /**
diff --git a/src/TranslatorInterface.php b/src/TranslatorInterface.php
@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Translator;
 
+use Stringable;
+
 /**
  * Translator translates a message into the specified language.
  */
@@ -34,8 +36,9 @@ public function getLocale(): string;
     /**
      * Translates a message into the specified language.
      *
-     * @param string $id The ID of the message to be translated. It can be either artificial ID or the source message.
-     * @param array  $parameters An array of parameters for the message.
+     * @param string|Stringable $id The ID of the message to be translated. It can be either artificial ID or the source
+     * message.
+     * @param array $parameters An array of parameters for the message.
      * @psalm-param array<array-key, mixed> $parameters
      *
      * @param string|null $category The message category. Null means default category.
@@ -44,7 +47,7 @@ public function getLocale(): string;
      * @return string The translated message or source string ID if translation was not found or is not required.
      */
     public function translate(
-        string $id,
+        string|Stringable $id,
         array $parameters = [],
         string $category = null,
         string $locale = null
