From 1439858fc8e266d1f9d149a2e554daa6e6475dd0 Mon Sep 17 00:00:00 2001
From: Marvin Petker <mp@borntocreate.de>
Date: Mon, 30 Oct 2023 22:15:43 +0100
Subject: [PATCH] [DependencyInjection] Add `urlencode` function to
 `EnvVarProcessor`

---
 .../Component/DependencyInjection/CHANGELOG.md        |  1 +
 .../Component/DependencyInjection/EnvVarProcessor.php |  5 +++++
 .../Compiler/RegisterEnvVarProcessorsPassTest.php     |  1 +
 .../DependencyInjection/Tests/EnvVarProcessorTest.php | 11 +++++++++++
 4 files changed, 18 insertions(+)

diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
index 0f38ac86c63ae..c7e3e7b1f58e2 100644
--- a/src/Symfony/Component/DependencyInjection/CHANGELOG.md
+++ b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * Deprecate `ContainerAwareInterface` and `ContainerAwareTrait`, use dependency injection instead
  * Add `defined` env var processor that returns `true` for defined and neither null nor empty env vars
  * Add `#[AutowireLocator]` and `#[AutowireIterator]` attributes
+ * Add `urlencode` env var processor that url encodes a string value
 
 6.3
 ---
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
index bae5e289d7eca..7376d03595264 100644
--- a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
+++ b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -57,6 +57,7 @@ public static function getProvidedTypes(): array
             'enum' => \BackedEnum::class,
             'shuffle' => 'array',
             'defined' => 'bool',
+            'urlencode' => 'string',
         ];
     }
 
@@ -344,6 +345,10 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed
             return trim($env);
         }
 
+        if ('urlencode' === $prefix) {
+            return rawurlencode($env);
+        }
+
         throw new RuntimeException(sprintf('Unsupported env var prefix "%s" for env name "%s".', $prefix, $name));
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php
index d23073c850bf8..f4a787b38b07f 100644
--- a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php
+++ b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php
@@ -51,6 +51,7 @@ public function testSimpleProcessor()
             'enum' => [\BackedEnum::class],
             'shuffle' => ['array'],
             'defined' => ['bool'],
+            'urlencode' => ['string'],
         ];
 
         $this->assertSame($expected, $container->getParameterBag()->getProvidedTypes());
diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
index 8de0eaf8fc255..12a9d7606bb11 100644
--- a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
+++ b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
@@ -948,6 +948,17 @@ public function testGetEnvDefined(bool $expected, callable $callback)
         $this->assertSame($expected, (new EnvVarProcessor(new Container()))->getEnv('defined', 'NO_SOMETHING', $callback));
     }
 
+    public function testGetEnvUrlencode()
+    {
+        $processor = new EnvVarProcessor(new Container());
+
+        $result = $processor->getEnv('urlencode', 'URLENCODETEST', function () {
+            return 'foo: Data123!@-_ + bar: Not the same content as Data123!@-_ +';
+        });
+
+        $this->assertSame('foo%3A%20Data123%21%40-_%20%2B%20bar%3A%20Not%20the%20same%20content%20as%20Data123%21%40-_%20%2B', $result);
+    }
+
     public static function provideGetEnvDefined(): iterable
     {
         yield 'Defined' => [true, fn () => 'foo'];