From 366879ba83bfff97dc1383874482eff5576a61dd Mon Sep 17 00:00:00 2001 From: Abdellatif Ait boudad Date: Sat, 5 Sep 2015 15:43:58 +0000 Subject: [PATCH] [Translator][FileDumper] deprecated format method in favor of formatCatalogue. --- src/Symfony/Component/Translation/CHANGELOG.md | 1 + .../Component/Translation/Dumper/CsvFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/FileDumper.php | 4 ++++ .../Component/Translation/Dumper/IcuResFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/IniFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/JsonFileDumper.php | 2 ++ .../Component/Translation/Dumper/MoFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/PhpFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/PoFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/QtFileDumper.php | 10 ++++++++++ .../Component/Translation/Dumper/XliffFileDumper.php | 2 ++ .../Component/Translation/Dumper/YamlFileDumper.php | 2 ++ .../Translation/Tests/Dumper/FileDumperTest.php | 7 ++++++- 13 files changed, 87 insertions(+), 1 deletion(-) diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md index f554079693626..69b13303bd27c 100644 --- a/src/Symfony/Component/Translation/CHANGELOG.md +++ b/src/Symfony/Component/Translation/CHANGELOG.md @@ -4,6 +4,7 @@ CHANGELOG 2.8.0 ----- + * deprecated FileDumper::format(), overwrite FileDumper::formatCatalogue() instead. * deprecated Translator::getMessages(), rely on TranslatorBagInterface::getCatalogue() instead. * added option `json_encoding` to JsonFileDumper * added options `as_tree`, `inline` to YamlFileDumper diff --git a/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php b/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php index 08005b097d54d..a4c4ef04af0a7 100644 --- a/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/CsvFileDumper.php @@ -27,6 +27,16 @@ class CsvFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain = 'messages') + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $handle = fopen('php://memory', 'rb+'); diff --git a/src/Symfony/Component/Translation/Dumper/FileDumper.php b/src/Symfony/Component/Translation/Dumper/FileDumper.php index 7620526f08e53..43f4eccababf8 100644 --- a/src/Symfony/Component/Translation/Dumper/FileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/FileDumper.php @@ -99,6 +99,8 @@ public function dump(MessageCatalogue $messages, $options = array()) */ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { + @trigger_error('The '.__METHOD__.' method will replace the format method in 3.0. You should overwritten it instead of overwriting format instead.', E_USER_DEPRECATED); + return $this->format($messages, $domain); } @@ -109,6 +111,8 @@ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $o * @param string $domain * * @return string representation + * + * @deprecated since version 2.8, to be removed in 3.0. Overwrite formatCatalogue() instead. */ abstract protected function format(MessageCatalogue $messages, $domain); diff --git a/src/Symfony/Component/Translation/Dumper/IcuResFileDumper.php b/src/Symfony/Component/Translation/Dumper/IcuResFileDumper.php index 0a2ed9f737335..95630431e58d9 100644 --- a/src/Symfony/Component/Translation/Dumper/IcuResFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/IcuResFileDumper.php @@ -29,6 +29,16 @@ class IcuResFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain = 'messages') + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $data = $indexes = $resources = ''; diff --git a/src/Symfony/Component/Translation/Dumper/IniFileDumper.php b/src/Symfony/Component/Translation/Dumper/IniFileDumper.php index 45df389bd6987..7018b3c1ea093 100644 --- a/src/Symfony/Component/Translation/Dumper/IniFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/IniFileDumper.php @@ -24,6 +24,16 @@ class IniFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain = 'messages') + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $output = ''; diff --git a/src/Symfony/Component/Translation/Dumper/JsonFileDumper.php b/src/Symfony/Component/Translation/Dumper/JsonFileDumper.php index 2f4156d8990a7..0a7f1321fdadd 100644 --- a/src/Symfony/Component/Translation/Dumper/JsonFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/JsonFileDumper.php @@ -25,6 +25,8 @@ class JsonFileDumper extends FileDumper */ public function format(MessageCatalogue $messages, $domain = 'messages') { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + return $this->formatCatalogue($messages, $domain); } diff --git a/src/Symfony/Component/Translation/Dumper/MoFileDumper.php b/src/Symfony/Component/Translation/Dumper/MoFileDumper.php index f8dc6ac395fc4..3758534e15e04 100644 --- a/src/Symfony/Component/Translation/Dumper/MoFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/MoFileDumper.php @@ -25,6 +25,16 @@ class MoFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain = 'messages') + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $output = $sources = $targets = $sourceOffsets = $targetOffsets = ''; $offsets = array(); diff --git a/src/Symfony/Component/Translation/Dumper/PhpFileDumper.php b/src/Symfony/Component/Translation/Dumper/PhpFileDumper.php index b354c1245c993..a3aa2e81f6b70 100644 --- a/src/Symfony/Component/Translation/Dumper/PhpFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/PhpFileDumper.php @@ -24,6 +24,16 @@ class PhpFileDumper extends FileDumper * {@inheritdoc} */ protected function format(MessageCatalogue $messages, $domain) + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $output = "all($domain), true).";\n"; diff --git a/src/Symfony/Component/Translation/Dumper/PoFileDumper.php b/src/Symfony/Component/Translation/Dumper/PoFileDumper.php index 983064b5d7ca9..e54f77a4604fa 100644 --- a/src/Symfony/Component/Translation/Dumper/PoFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/PoFileDumper.php @@ -24,6 +24,16 @@ class PoFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain = 'messages') + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $output = 'msgid ""'."\n"; $output .= 'msgstr ""'."\n"; diff --git a/src/Symfony/Component/Translation/Dumper/QtFileDumper.php b/src/Symfony/Component/Translation/Dumper/QtFileDumper.php index 42aa093481493..256083f7d5bdf 100644 --- a/src/Symfony/Component/Translation/Dumper/QtFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/QtFileDumper.php @@ -24,6 +24,16 @@ class QtFileDumper extends FileDumper * {@inheritdoc} */ public function format(MessageCatalogue $messages, $domain) + { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + + return $this->formatCatalogue($messages, $domain); + } + + /** + * {@inheritdoc} + */ + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { $dom = new \DOMDocument('1.0', 'utf-8'); $dom->formatOutput = true; diff --git a/src/Symfony/Component/Translation/Dumper/XliffFileDumper.php b/src/Symfony/Component/Translation/Dumper/XliffFileDumper.php index d8afa554a28b3..ee62eec169a08 100644 --- a/src/Symfony/Component/Translation/Dumper/XliffFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/XliffFileDumper.php @@ -51,6 +51,8 @@ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $o */ protected function format(MessageCatalogue $messages, $domain) { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + return $this->formatCatalogue($messages, $domain); } diff --git a/src/Symfony/Component/Translation/Dumper/YamlFileDumper.php b/src/Symfony/Component/Translation/Dumper/YamlFileDumper.php index e27f8b376dbed..611f77fb5118e 100644 --- a/src/Symfony/Component/Translation/Dumper/YamlFileDumper.php +++ b/src/Symfony/Component/Translation/Dumper/YamlFileDumper.php @@ -49,6 +49,8 @@ protected function formatCatalogue(MessageCatalogue $messages, $domain, array $o */ protected function format(MessageCatalogue $messages, $domain) { + @trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0. Use the formatCatalogue() method instead.', E_USER_DEPRECATED); + return $this->formatCatalogue($messages, $domain); } diff --git a/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php b/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php index 96820890922a0..33b1b9107fa7b 100644 --- a/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php +++ b/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php @@ -58,11 +58,16 @@ public function testDumpCreatesNestedDirectoriesAndFile() class ConcreteFileDumper extends FileDumper { - protected function format(MessageCatalogue $messages, $domain) + protected function formatCatalogue(MessageCatalogue $messages, $domain, array $options = array()) { return ''; } + protected function format(MessageCatalogue $messages, $domain) + { + return $this->formatCatalogue($messages, $domain); + } + protected function getExtension() { return 'concrete'; pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy