feature #5745 [Translation] Ability to format a message catalogue without actually writing it. (aitboudad)

xabbuh · xabbuh · commit 6468cd520dbc · 2015-10-05T19:45:24.000+02:00
This PR was merged into the 2.8 branch. Discussion ---------- [Translation] Ability to format a message catalogue without actually writing it. | Q | A | ------------- | --- | Doc fix? | no | New docs? | yes | Applies to | all | Fixed tickets | #5743 Commits ------- 7e3ab6f [Translation] Ability to format a message catalogue without dumping it.
diff --git a/components/translation/custom_formats.rst b/components/translation/custom_formats.rst
@@ -85,7 +85,7 @@ will save a few lines::
 
     class MyFormatDumper extends FileDumper
     {
-        protected function format(MessageCatalogue $messages, $domain = 'messages')
+        public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
         {
             $output = '';
 
@@ -102,7 +102,16 @@ will save a few lines::
         }
     }
 
-The :method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::format`
+.. sidebar:: Format a message catalogue
+
+    .. versionadded:: 2.8
+        The ability to format a message catalogue without dumping it was introduced in Symfony 2.8.
+
+    In some cases, you want to send the dump contents as a response instead of writing them in files.
+    To do this, you can use the ``formatCatalogue`` method. In this case, you must pass the domain argument,
+    which determines the list of messages that should be dumped.
+
+The :method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::formatCatalogue`
 method creates the output string, that will be used by the
 :method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::dump` method
 of the FileDumper class to create the file. The dumper can be used like any other
@@ -116,4 +125,3 @@ YAML file are dumped into a text file with the custom format::
 
     $dumper = new MyFormatDumper();
     $dumper->dump($catalogue, array('path' => __DIR__.'/dumps'));
-
