feature #40554 [Contracts] Add TranslatorInterface::getLocale() (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit 7f640123cb55 · 2021-03-23T22:10:30.000+01:00
This PR was merged into the 5.3-dev branch. Discussion ---------- [Contracts] Add `TranslatorInterface::getLocale()` | Q | A | ------------- | --- | Branch? | 5.x | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Fix #40380 | License | MIT | Doc PR | - As discussed in #40380 Commits ------- 45d9a36 [Contracts/Translation] Add `TranslatorInterface::getLocale()`
diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/Fixtures/StubTranslator.php b/src/Symfony/Bridge/Twig/Tests/Extension/Fixtures/StubTranslator.php
@@ -19,4 +19,9 @@ public function trans($id, array $parameters = [], $domain = null, $locale = nul
     {
         return '[trans]'.strtr($id, $parameters).'[/trans]';
     }
+
+    public function getLocale(): string
+    {
+        return 'en';
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/DataCollectorTranslatorPassTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/DependencyInjection/Compiler/DataCollectorTranslatorPassTest.php
@@ -111,4 +111,9 @@ class TranslatorWithTranslatorBag implements TranslatorInterface
     public function trans(string $id, array $parameters = [], string $domain = null, string $locale = null): string
     {
     }
+
+    public function getLocale(): string
+    {
+        return 'en';
+    }
 }
diff --git a/src/Symfony/Component/Translation/PseudoLocalizationTranslator.php b/src/Symfony/Component/Translation/PseudoLocalizationTranslator.php
@@ -108,6 +108,11 @@ public function trans(string $id, array $parameters = [], string $domain = null,
         return $trans;
     }
 
+    public function getLocale(): string
+    {
+        return $this->translator->getLocale();
+    }
+
     private function getParts(string $originalTrans): array
     {
         if (!$this->parseHTML) {
diff --git a/src/Symfony/Contracts/CHANGELOG.md b/src/Symfony/Contracts/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `HttpClientInterface::withOptions()`
+ * Add `TranslatorInterface::getLocale()`
 
 2.3.0
 -----
diff --git a/src/Symfony/Contracts/Translation/TranslatorInterface.php b/src/Symfony/Contracts/Translation/TranslatorInterface.php
@@ -13,6 +13,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @method string getLocale() Returns the default locale
  */
 interface TranslatorInterface
 {
diff --git a/src/Symfony/Contracts/Translation/TranslatorTrait.php b/src/Symfony/Contracts/Translation/TranslatorTrait.php
@@ -32,6 +32,8 @@ public function setLocale(string $locale)
 
     /**
      * {@inheritdoc}
+     *
+     * @return string
      */
     public function getLocale()
     {

Original file line number	Diff line number	Diff line change
`@@ -19,4 +19,9 @@ public function trans($id, array $parameters = [], $domain = null, $locale = nul`
`19`	`19`	`{`
`20`	`20`	`return '[trans]'.strtr($id, $parameters).'[/trans]';`
`21`	`21`	`}`
	`22`	`+`
	`23`	`+ public function getLocale(): string`
	`24`	`+ {`
	`25`	`+ return 'en';`
	`26`	`+ }`
`22`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,4 +111,9 @@ class TranslatorWithTranslatorBag implements TranslatorInterface`
`111`	`111`	`public function trans(string $id, array $parameters = [], string $domain = null, string $locale = null): string`
`112`	`112`	`{`
`113`	`113`	`}`
	`114`	`+`
	`115`	`+ public function getLocale(): string`
	`116`	`+ {`
	`117`	`+ return 'en';`
	`118`	`+ }`
`114`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -108,6 +108,11 @@ public function trans(string $id, array $parameters = [], string $domain = null,`
`108`	`108`	`return $trans;`
`109`	`109`	`}`
`110`	`110`
	`111`	`+ public function getLocale(): string`
	`112`	`+ {`
	`113`	`+ return $this->translator->getLocale();`
	`114`	`+ }`
	`115`	`+`
`111`	`116`	`private function getParts(string $originalTrans): array`
`112`	`117`	`{`
`113`	`118`	`if (!$this->parseHTML) {`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@`
`13`	`13`
`14`	`14`	`/**`
`15`	`15`	`* @author Fabien Potencier <fabien@symfony.com>`
	`16`	`+ *`
	`17`	`+ * @method string getLocale() Returns the default locale`
`16`	`18`	`*/`
`17`	`19`	`interface TranslatorInterface`
`18`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,8 @@ public function setLocale(string $locale)`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* {@inheritdoc}`
	`35`	`+ *`
	`36`	`+ * @return string`
`35`	`37`	`*/`
`36`	`38`	`public function getLocale()`
`37`	`39`	`{`