[Translator] deprecate getMessages in favor of getCatalogue.

aitboudad · aitboudad · commit 472f8b77496c · 2015-05-05T10:36:49.000Z
diff --git a/UPGRADE-2.8.md b/UPGRADE-2.8.md
@@ -0,0 +1,24 @@
+﻿UPGRADE FROM 2.7 to 2.8
+=======================
+
+Translator
+----------
+ * The `getMessages()` method of the `Symfony\Component\Translation\Translator` was deprecated and will be removed in
+   Symfony 3.0. You should use the `getCatalogue()` method of the `Symfony\Component\Translation\TranslatorBagInterface`.
+
+   Before:
+
+   ```php
+   $messages = $translator->getMessages();
+   ```
+
+   After:
+
+   ```php
+    $catalogue = $translator->getCatalogue($locale);
+    $messages = $catalogue->all();
+
+    while ($catalogue = $catalogue->getFallbackCatalogue()) {
+        $messages = array_replace_recursive($catalogue->all(), $messages);
+    }
+   ```
diff --git a/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php b/src/Symfony/Bundle/FrameworkBundle/Translation/Translator.php
@@ -78,7 +78,7 @@ public function __construct(ContainerInterface $container, MessageSelector $sele
     public function warmUp($cacheDir)
     {
         foreach ($this->resourceLocales as $locale) {
-            $this->loadCatalogue($locale);
+            $this->getCatalogue($locale);
         }
     }
 
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+2.8.0
+-----
+ * deprecated Translator::getMessages() and Translator::loadCatalogue(),
+   rely on the TranslatorBagInterface::getCatalogue() instead.
+
 2.7.0
 -----
 
diff --git a/src/Symfony/Component/Translation/Tests/TranslatorTest.php b/src/Symfony/Component/Translation/Tests/TranslatorTest.php
@@ -499,8 +499,10 @@ public function testTransChoiceFallbackWithNoTranslation()
     /**
      * @dataProvider dataProviderGetMessages
      */
-    public function testGetMessages($resources, $locale, $expected)
+    public function testLegacyGetMessages($resources, $locale, $expected)
     {
+        $this->iniSet('error_reporting', -1 & ~E_USER_DEPRECATED);
+
         $locales = array_keys($resources);
         $_locale = !is_null($locale) ? $locale : reset($locales);
         $locales = array_slice($locales, 0, array_search($_locale, $locales));
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php
@@ -267,7 +267,11 @@ public function getCatalogue($locale = null)
         }
 
         if (!isset($this->catalogues[$locale])) {
-            $this->loadCatalogue($locale);
+            if (null === $this->cacheDir) {
+                $this->initializeCatalogue($locale);
+            } else {
+                $this->initializeCacheCatalogue($locale);
+            }
         }
 
         return $this->catalogues[$locale];
@@ -292,6 +296,8 @@ protected function getLoaders()
      */
     public function getMessages($locale = null)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Rely on the TranslatorBagInterface instead', E_USER_DEPRECATED);
+
         $catalogues = array();
         $catalogues[] = $catalogue = $this->getCatalogue($locale);
         while ($catalogue = $catalogue->getFallbackCatalogue()) {
@@ -311,11 +317,9 @@ public function getMessages($locale = null)
      */
     protected function loadCatalogue($locale)
     {
-        if (null === $this->cacheDir) {
-            $this->initializeCatalogue($locale);
-        } else {
-            $this->initializeCacheCatalogue($locale);
-        }
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Rely on the TranslatorBagInterface instead', E_USER_DEPRECATED);
+
+        $this->getCatalogue($locale);
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ public function __construct(ContainerInterface $container, MessageSelector $sele`
`78`	`78`	`public function warmUp($cacheDir)`
`79`	`79`	`{`
`80`	`80`	`foreach ($this->resourceLocales as $locale) {`
`81`		`- $this->loadCatalogue($locale);`
	`81`	`+ $this->getCatalogue($locale);`
`82`	`82`	`}`
`83`	`83`	`}`
`84`	`84`