[Translation] Remove deprecated escape parameter from CsvFileLoader

OskarStark · OskarStark · commit c44a2e886fa6 · 2025-06-27T17:29:34.000+02:00
diff --git a/UPGRADE-8.0.md b/UPGRADE-8.0.md
@@ -352,6 +352,31 @@ Serializer
  * Remove `AdvancedNameConverterInterface`, use `NameConverterInterface` instead
  * Remove the `CompiledClassMetadataFactory` and `CompiledClassMetadataCacheWarmer` classes
 
+Translation
+-----------
+
+ * Remove the `$escape` parameter from `CsvFileLoader::setCsvControl()`
+
+   *Before*
+   ```php
+   use Symfony\Component\Translation\Loader\CsvFileLoader;
+
+   $loader = new CsvFileLoader();
+   
+   // Set CSV control characters including escape character
+   $loader->setCsvControl(';', '"', '\\');
+   ```
+
+   *After*
+   ```php
+   use Symfony\Component\Translation\Loader\CsvFileLoader;
+
+   $loader = new CsvFileLoader();
+   
+   // The escape parameter has been removed
+   $loader->setCsvControl(';', '"');
+   ```
+
 TwigBridge
 ----------
 
diff --git a/src/Symfony/Component/Translation/CHANGELOG.md b/src/Symfony/Component/Translation/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+8.0
+---
+
+ * Remove the `$escape` parameter from `CsvFileLoader::setCsvControl()`
+ * Remove `symfony/deprecation-contracts` dependency
+
 7.3
 ---
 
diff --git a/src/Symfony/Component/Translation/Loader/CsvFileLoader.php b/src/Symfony/Component/Translation/Loader/CsvFileLoader.php
@@ -22,10 +22,6 @@ 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
     {
@@ -38,7 +34,7 @@ protected function loadResource(string $resource): array
         }
 
         $file->setFlags(\SplFileObject::READ_CSV | \SplFileObject::SKIP_EMPTY);
-        $file->setCsvControl($this->delimiter, $this->enclosure, $this->escape);
+        $file->setCsvControl($this->delimiter, $this->enclosure);
 
         foreach ($file as $data) {
             if (false === $data) {
@@ -54,16 +50,11 @@ protected function loadResource(string $resource): array
     }
 
     /**
-     * Sets the delimiter, enclosure, and escape character for CSV.
+     * Sets the delimiter and enclosure character for CSV.
      */
-    public function setCsvControl(string $delimiter = ';', string $enclosure = '"', string $escape = ''): void
+    public function setCsvControl(string $delimiter = ';', string $enclosure = '"'): void
     {
         $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;
     }
 }
diff --git a/src/Symfony/Component/Translation/Tests/Loader/CsvFileLoaderTest.php b/src/Symfony/Component/Translation/Tests/Loader/CsvFileLoaderTest.php
@@ -58,14 +58,4 @@ public function testLoadNonLocalResource()
         (new CsvFileLoader())->load('http://example.com/resources.csv', 'en', 'domain1');
     }
 
-    /**
-     * @group legacy
-     */
-    public function testEscapeCharInCsvControlIsDeprecated()
-    {
-        $loader = new CsvFileLoader();
-
-        $this->expectUserDeprecationMessage('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(';', '"', '\\');
-    }
 }
diff --git a/src/Symfony/Component/Translation/composer.json b/src/Symfony/Component/Translation/composer.json
@@ -17,7 +17,6 @@
     ],
     "require": {
         "php": ">=8.4",
-        "symfony/deprecation-contracts": "^2.5|^3",
         "symfony/polyfill-mbstring": "^1.0",
         "symfony/translation-contracts": "^2.5|^3.0"
     },

Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,6 @@ class CsvFileLoader extends FileLoader`
`22`	`22`	`{`
`23`	`23`	`private string $delimiter = ';';`
`24`	`24`	`private string $enclosure = '"';`
`25`		`- /**`
`26`		`- * @deprecated since Symfony 7.2, to be removed in 8.0`
`27`		`- */`
`28`		`- private string $escape = '';`
`29`	`25`
`30`	`26`	`protected function loadResource(string $resource): array`
`31`	`27`	`{`
`@@ -38,7 +34,7 @@ protected function loadResource(string $resource): array`
`38`	`34`	`}`
`39`	`35`
`40`	`36`	`$file->setFlags(\SplFileObject::READ_CSV \| \SplFileObject::SKIP_EMPTY);`
`41`		`- $file->setCsvControl($this->delimiter, $this->enclosure, $this->escape);`
	`37`	`+ $file->setCsvControl($this->delimiter, $this->enclosure);`
`42`	`38`
`43`	`39`	`foreach ($file as $data) {`
`44`	`40`	`if (false === $data) {`
`@@ -54,16 +50,11 @@ protected function loadResource(string $resource): array`
`54`	`50`	`}`
`55`	`51`
`56`	`52`	`/**`
`57`		`- * Sets the delimiter, enclosure, and escape character for CSV.`
	`53`	`+ * Sets the delimiter and enclosure character for CSV.`
`58`	`54`	`*/`
`59`		`- public function setCsvControl(string $delimiter = ';', string $enclosure = '"', string $escape = ''): void`
	`55`	`+ public function setCsvControl(string $delimiter = ';', string $enclosure = '"'): void`
`60`	`56`	`{`
`61`	`57`	`$this->delimiter = $delimiter;`
`62`	`58`	`$this->enclosure = $enclosure;`
`63`		`- if ('' !== $escape) {`
`64`		`- trigger_deprecation('symfony/translation', '7.2', 'The "escape" parameter of the "%s" method is deprecated. It will be removed in 8.0.', __METHOD__);`
`65`		`- }`
`66`		`-`
`67`		`- $this->escape = $escape;`
`68`	`59`	`}`
`69`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,14 +58,4 @@ public function testLoadNonLocalResource()`
`58`	`58`	`(new CsvFileLoader())->load('http://example.com/resources.csv', 'en', 'domain1');`
`59`	`59`	`}`
`60`	`60`
`61`		`- /**`
`62`		`- * @group legacy`
`63`		`- */`
`64`		`- public function testEscapeCharInCsvControlIsDeprecated()`
`65`		`- {`
`66`		`- $loader = new CsvFileLoader();`
`67`		`-`
`68`		`- $this->expectUserDeprecationMessage('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.');`
`69`		`- $loader->setCsvControl(';', '"', '\\');`
`70`		`- }`
`71`	`61`	`}`