Skip to content

Commit aa7ae8a

Browse files
committed
[Translation] Ability to format a message catalogue without dumping it.
1 parent 25fe737 commit aa7ae8a

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

Diff for: components/translation/custom_formats.rst

+15-3
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ will save a few lines::
8585

8686
class MyFormatDumper extends FileDumper
8787
{
88-
protected function format(MessageCatalogue $messages, $domain = 'messages')
88+
public function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array())
8989
{
9090
$output = '';
9191

@@ -102,7 +102,20 @@ will save a few lines::
102102
}
103103
}
104104

105-
The :method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::format`
105+
.. sidebar:: Format a message catalogue
106+
107+
.. versionadded:: 2.8
108+
The ability to format a message catalogue without dumping it was introduced in Symfony 2.8.
109+
110+
In some cases, you want to send the the dump contents as a response instead of writing in files.
111+
To do this, you can use the ``formatCatalogue`` method. In this case, you must pass the domain argument,
112+
which determines the list of messages that should be dumped.
113+
114+
.. tip::
115+
116+
To format a message catalogue without dumping it into files use the ``formatCatalogue`` method.
117+
118+
The :method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::formatCatalogue`
106119
method creates the output string, that will be used by the
107120
:method:`Symfony\\Component\\Translation\\Dumper\\FileDumper::dump` method
108121
of the FileDumper class to create the file. The dumper can be used like any other
@@ -116,4 +129,3 @@ YAML file are dumped into a text file with the custom format::
116129

117130
$dumper = new MyFormatDumper();
118131
$dumper->dump($catalogue, array('path' => __DIR__.'/dumps'));
119-

0 commit comments

Comments
 (0)