feature #18290 [Translation] deprecate the backup feature (xabbuh)

fabpot · fabpot · commit d177747812d4 · 2016-04-01T08:29:04.000+02:00
This PR was merged into the 3.1-dev branch. Discussion ---------- [Translation] deprecate the backup feature | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #16912 (comment) | License | MIT | Doc PR | Commits ------- 6c3ddf1 [Translation] deprecate the backup feature
diff --git a/UPGRADE-3.1.md b/UPGRADE-3.1.md
@@ -72,6 +72,12 @@ Serializer
    deprecated and will not be supported in Symfony 4.0. You should use the
    `CacheClassMetadataFactory` class instead.
 
+Translation
+-----------
+
+ * Deprecated the backup feature of the file dumper classes. It will be removed
+   in Symfony 4.0.
+
 Yaml
 ----
 
diff --git a/UPGRADE-4.0.md b/UPGRADE-4.0.md
@@ -68,6 +68,11 @@ Serializer
    class has been removed. You should use the `CacheClassMetadataFactory` class
    instead.
 
+Translation
+-----------
+
+ * Removed the backup feature from the file dumper classes.
+
 Yaml
 ----
 
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+3.1.0
+-----
+
+ * Deprecated the backup feature of the file dumper classes.
+
 3.0.0
 -----
 
diff --git a/src/Symfony/Component/Translation/Dumper/FileDumper.php b/src/Symfony/Component/Translation/Dumper/FileDumper.php
@@ -73,6 +73,7 @@ public function dump(MessageCatalogue $messages, $options = array())
             $fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());
             if (file_exists($fullpath)) {
                 if ($this->backup) {
+                    @trigger_error('Creating a backup while dumping a message catalogue is deprecated since version 3.1 and will be removed in 4.0. Use TranslationWriter::disableBackup() to disable the backup.', E_USER_DEPRECATED);
                     copy($fullpath, $fullpath.'~');
                 }
             } else {
diff --git a/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php b/src/Symfony/Component/Translation/Tests/Dumper/FileDumperTest.php
@@ -29,6 +29,9 @@ public function testDump()
         $this->assertTrue(file_exists($tempDir.'/messages.en.concrete'));
     }
 
+    /**
+     * @group legacy
+     */
     public function testDumpBackupsFileIfExisting()
     {
         $tempDir = sys_get_temp_dir();

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ public function dump(MessageCatalogue $messages, $options = array())`
`73`	`73`	`$fullpath = $options['path'].'/'.$this->getRelativePath($domain, $messages->getLocale());`
`74`	`74`	`if (file_exists($fullpath)) {`
`75`	`75`	`if ($this->backup) {`
	`76`	`+ @trigger_error('Creating a backup while dumping a message catalogue is deprecated since version 3.1 and will be removed in 4.0. Use TranslationWriter::disableBackup() to disable the backup.', E_USER_DEPRECATED);`
`76`	`77`	`copy($fullpath, $fullpath.'~');`
`77`	`78`	`}`
`78`	`79`	`} else {`
Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,9 @@ public function testDump()`
`29`	`29`	`$this->assertTrue(file_exists($tempDir.'/messages.en.concrete'));`
`30`	`30`	`}`
`31`	`31`
	`32`	`+ /**`
	`33`	`+ * @group legacy`
	`34`	`+ */`
`32`	`35`	`public function testDumpBackupsFileIfExisting()`
`33`	`36`	`{`
`34`	`37`	`$tempDir = sys_get_temp_dir();`