[Translation] deprecate passing a null locale

Simperfit · Simperfit · commit bca34cf1fe9e · 2019-07-07T20:36:56.000+02:00
diff --git a/src/Symfony/Component/Translation/MessageCatalogue.php b/src/Symfony/Component/Translation/MessageCatalogue.php
@@ -32,6 +32,10 @@ class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterf
      */
     public function __construct(?string $locale, array $messages = [])
     {
+        if (null === $locale) {
+            @trigger_error(sprintf('Passing "null" to "$locale" in %s has been deprecated since Symfony 4.4 and will throw an error in 5.0.', __METHOD__), E_USER_DEPRECATED);
+        }
+
         $this->locale = $locale;
         $this->messages = $messages;
     }
diff --git a/src/Symfony/Component/Translation/Tests/MessageCatalogueTest.php b/src/Symfony/Component/Translation/Tests/MessageCatalogueTest.php
@@ -23,6 +23,17 @@ public function testGetLocale()
         $this->assertEquals('en', $catalogue->getLocale());
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation  Passing "null" to "$locale" in Symfony\Component\Translation\MessageCatalogue::__construct has been deprecated since Symfony 4.4 and will throw an error in 5.0.
+     */
+    public function testGetNullLocale()
+    {
+        $catalogue = new MessageCatalogue(null);
+
+        $this->assertNull($catalogue->getLocale());
+    }
+
     public function testGetDomains()
     {
         $catalogue = new MessageCatalogue('en', ['domain1' => [], 'domain2' => [], 'domain2+intl-icu' => [], 'domain3+intl-icu' => []]);
diff --git a/src/Symfony/Component/Translation/Tests/TranslatorTest.php b/src/Symfony/Component/Translation/Tests/TranslatorTest.php
@@ -184,12 +184,26 @@ public function testAddResourceInvalidLocales($locale)
      */
     public function testAddResourceValidLocales($locale)
     {
+        if ($locale === null) {
+            $this->markTestSkipped('null is not a valid locale');
+        }
         $translator = new Translator('fr');
         $translator->addResource('array', ['foo' => 'foofoo'], $locale);
         // no assertion. this method just asserts that no exception is thrown
         $this->addToAssertionCount(1);
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation  Passing "null" to "$locale" in Symfony\Component\Translation\Translator::addResource has been deprecated since Symfony 4.4 and will throw an error in 5.0.
+     */
+    public function testAddResourceNull()
+    {
+        $translator = new Translator('fr');
+        $translator->addResource('array', ['foo' => 'foofoo'], null);
+        // no assertion. this method just asserts that no exception is thrown
+    }
+
     public function testAddResourceAfterTrans()
     {
         $translator = new Translator('fr');
@@ -367,10 +381,13 @@ public function testTransInvalidLocale($locale)
     }
 
     /**
-     * @dataProvider      getValidLocalesTests
+     * @dataProvider getValidLocalesTests
      */
     public function testTransValidLocale($locale)
     {
+        if ($locale === null) {
+            $this->markTestSkipped('null is not a valid locale');
+        }
         $translator = new Translator($locale);
         $translator->addLoader('array', new ArrayLoader());
         $translator->addResource('array', ['test' => 'OK'], $locale);
@@ -379,6 +396,17 @@ public function testTransValidLocale($locale)
         $this->assertEquals('OK', $translator->trans('test', [], null, $locale));
     }
 
+    /**
+     * @group legacy
+     * @expectedDeprecation Passing "null" to "$locale" in Symfony\Component\Translation\Translator::addResource has been deprecated since Symfony 4.4 and will throw an error in 5.0.
+     */
+    public function testTransNullLocale()
+    {
+        $translator = new Translator(null);
+        $translator->addLoader('array', new ArrayLoader());
+        $translator->addResource('array', ['test' => 'OK'], null);
+    }
+
     /**
      * @dataProvider getFlattenedTransTests
      */
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php
@@ -132,6 +132,10 @@ public function addResource($format, $resource, $locale, $domain = null)
             $domain = 'messages';
         }
 
+        if (null === $locale) {
+            @trigger_error(sprintf('Passing "null" to "$locale" in %s has been deprecated since Symfony 4.4 and will throw an error in 5.0.', __METHOD__), E_USER_DEPRECATED);
+        }
+
         $this->assertValidLocale($locale);
 
         $this->resources[$locale][] = [$format, $resource, $domain];

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,10 @@ class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterf`
`32`	`32`	`*/`
`33`	`33`	`public function __construct(?string $locale, array $messages = [])`
`34`	`34`	`{`
	`35`	`+ if (null === $locale) {`
	`36`	`+ @trigger_error(sprintf('Passing "null" to "$locale" in %s has been deprecated since Symfony 4.4 and will throw an error in 5.0.', __METHOD__), E_USER_DEPRECATED);`
	`37`	`+ }`
	`38`	`+`
`35`	`39`	`$this->locale = $locale;`
`36`	`40`	`$this->messages = $messages;`
`37`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -132,6 +132,10 @@ public function addResource($format, $resource, $locale, $domain = null)`
`132`	`132`	`$domain = 'messages';`
`133`	`133`	`}`
`134`	`134`
	`135`	`+ if (null === $locale) {`
	`136`	`+ @trigger_error(sprintf('Passing "null" to "$locale" in %s has been deprecated since Symfony 4.4 and will throw an error in 5.0.', __METHOD__), E_USER_DEPRECATED);`
	`137`	`+ }`
	`138`	`+`
`135`	`139`	`$this->assertValidLocale($locale);`
`136`	`140`
`137`	`141`	`$this->resources[$locale][] = [$format, $resource, $domain];`