[Serializer][Translation] Deprecate passing a non-empty CSV escape char

Author: alexandre-daubois

CHANGELOG.md

@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `lint:translations` command
+ * Deprecate passing an escape character to `CsvFileLoader::setCsvControl()`
 
 7.1
 ---

Loader/CsvFileLoader.php

@@ -22,6 +22,9 @@ class CsvFileLoader extends FileLoader
 {
     private string $delimiter = ';';
     private string $enclosure = '"';
+    /**
+     * @deprecated since Symfony 7.2, to be removed in 8.0
+     */
     private string $escape = '';
 
     protected function loadResource(string $resource): array
@@ -57,6 +60,10 @@ public function setCsvControl(string $delimiter = ';', string $enclosure = '"',
     {
         $this->delimiter = $delimiter;
         $this->enclosure = $enclosure;
+        if ('' !== $escape) {
+            trigger_deprecation('symfony/translation', '7.2', 'The "escape" parameter of the "%s" method is deprecated. It will be removed in 8.0.', __METHOD__);
+        }
+
         $this->escape = $escape;
     }
 }

Tests/Loader/CsvFileLoaderTest.php

@@ -12,13 +12,16 @@
 namespace Symfony\Component\Translation\Tests\Loader;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Translation\Exception\InvalidResourceException;
 use Symfony\Component\Translation\Exception\NotFoundResourceException;
 use Symfony\Component\Translation\Loader\CsvFileLoader;
 
 class CsvFileLoaderTest extends TestCase
 {
+    use ExpectDeprecationTrait;
+
     public function testLoad()
     {
         $loader = new CsvFileLoader();
@@ -54,4 +57,15 @@ public function testLoadNonLocalResource()
 
         (new CsvFileLoader())->load('http://example.com/resources.csv', 'en', 'domain1');
     }
+
+    /**
+     * @group legacy
+     */
+    public function testEscapeCharInCsvControlIsDeprecated()
+    {
+        $loader = new CsvFileLoader();
+
+        $this->expectDeprecation('Since symfony/translation 7.2: The "escape" parameter of the "Symfony\Component\Translation\Loader\CsvFileLoader::setCsvControl" method is deprecated. It will be removed in 8.0.');
+        $loader->setCsvControl(';', '"', '\\');
+    }
 }

composer.json

@@ -18,7 +18,8 @@
     "require": {
         "php": ">=8.2",
         "symfony/polyfill-mbstring": "~1.0",
-        "symfony/translation-contracts": "^2.5|^3.0"
+        "symfony/translation-contracts": "^2.5|^3.0",
+        "symfony/deprecation-contracts": "^2.5|^3"
     },
     "require-dev": {
         "nikic/php-parser": "^4.18|^5.0",