feature #14546 [Translator] deprecate getMessages in favor of getCatalogue. (aitboudad)

aitboudad · aitboudad · commit 55b352538b51 · 2015-05-06T11:02:29.000Z
This PR was merged into the 2.8 branch. Discussion ---------- [Translator] deprecate getMessages in favor of getCatalogue. | Q | A | ------------- | --- | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Fixed tickets | #14529 | Tests pass? | yes | License | MIT Commits ------- 2869a32 [Translator] deprecate getMessages in favor of getCatalogue.
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/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,10 @@
 CHANGELOG
 =========
 
+2.8.0
+-----
+ * deprecated Translator::getMessages(), rely on the TranslatorBagInterface::getCatalogue() method instead.
+
 2.7.0
 -----
 
diff --git a/src/Symfony/Component/Translation/Tests/TranslatorTest.php b/src/Symfony/Component/Translation/Tests/TranslatorTest.php
@@ -497,9 +497,10 @@ public function testTransChoiceFallbackWithNoTranslation()
     }
 
     /**
+     * @group legacy
      * @dataProvider dataProviderGetMessages
      */
-    public function testGetMessages($resources, $locale, $expected)
+    public function testLegacyGetMessages($resources, $locale, $expected)
     {
         $locales = array_keys($resources);
         $_locale = !is_null($locale) ? $locale : reset($locales);
diff --git a/src/Symfony/Component/Translation/Translator.php b/src/Symfony/Component/Translation/Translator.php
@@ -292,6 +292,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::getCatalogue() method instead', E_USER_DEPRECATED);
+
         $catalogues = array();
         $catalogues[] = $catalogue = $this->getCatalogue($locale);
         while ($catalogue = $catalogue->getFallbackCatalogue()) {

Original file line number	Diff line number	Diff line change
`@@ -497,9 +497,10 @@ public function testTransChoiceFallbackWithNoTranslation()`
`497`	`497`	`}`
`498`	`498`
`499`	`499`	`/**`
	`500`	`+ * @group legacy`
`500`	`501`	`* @dataProvider dataProviderGetMessages`
`501`	`502`	`*/`
`502`		`- public function testGetMessages($resources, $locale, $expected)`
	`503`	`+ public function testLegacyGetMessages($resources, $locale, $expected)`
`503`	`504`	`{`
`504`	`505`	`$locales = array_keys($resources);`
`505`	`506`	`$_locale = !is_null($locale) ? $locale : reset($locales);`
Original file line number	Diff line number	Diff line change
`@@ -292,6 +292,8 @@ protected function getLoaders()`
`292`	`292`	`*/`
`293`	`293`	`public function getMessages($locale = null)`
`294`	`294`	`{`
	`295`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Rely on the TranslatorBagInterface::getCatalogue() method instead', E_USER_DEPRECATED);`
	`296`	`+`
`295`	`297`	`$catalogues = array();`
`296`	`298`	`$catalogues[] = $catalogue = $this->getCatalogue($locale);`
`297`	`299`	`while ($catalogue = $catalogue->getFallbackCatalogue()) {`