[HttpClient] Add HttpOptions->addHeader as a shortcut to add an header in an existing options object

Dean151 · fabpot · commit 266e50f4c489 · 2023-12-08T15:41:47.000+01:00
diff --git a/src/Symfony/Component/HttpClient/HttpOptions.php b/src/Symfony/Component/HttpClient/HttpOptions.php
@@ -63,6 +63,17 @@ public function setQuery(array $query): static
         return $this;
     }
 
+    /**
+     * @return $this
+     */
+    public function addHeader(string $key, string $value): static
+    {
+        $this->options['headers'] ??= [];
+        $this->options['headers'][$key] = $value;
+
+        return $this;
+    }
+
     /**
      * @return $this
      */
diff --git a/src/Symfony/Component/HttpClient/Tests/HttpOptionsTest.php b/src/Symfony/Component/HttpClient/Tests/HttpOptionsTest.php
@@ -39,4 +39,15 @@ public function testSetAuthBearer()
     {
         $this->assertSame('foobar', (new HttpOptions())->setAuthBearer('foobar')->toArray()['auth_bearer']);
     }
+
+    public function testAddHeader()
+    {
+        $options = new HttpOptions();
+        $options->addHeader('Accept', 'application/json');
+        $this->assertSame(['Accept' => 'application/json'], $options->toArray()['headers']);
+        $options->addHeader('Accept-Language', 'en-US,en;q=0.5');
+        $this->assertSame(['Accept' => 'application/json', 'Accept-Language' => 'en-US,en;q=0.5'], $options->toArray()['headers']);
+        $options->addHeader('Accept', 'application/html');
+        $this->assertSame(['Accept' => 'application/html', 'Accept-Language' => 'en-US,en;q=0.5'], $options->toArray()['headers']);
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -39,4 +39,15 @@ public function testSetAuthBearer()`
`39`	`39`	`{`
`40`	`40`	`$this->assertSame('foobar', (new HttpOptions())->setAuthBearer('foobar')->toArray()['auth_bearer']);`
`41`	`41`	`}`
	`42`	`+`
	`43`	`+ public function testAddHeader()`
	`44`	`+ {`
	`45`	`+ $options = new HttpOptions();`
	`46`	`+ $options->addHeader('Accept', 'application/json');`
	`47`	`+ $this->assertSame(['Accept' => 'application/json'], $options->toArray()['headers']);`
	`48`	`+ $options->addHeader('Accept-Language', 'en-US,en;q=0.5');`
	`49`	`+ $this->assertSame(['Accept' => 'application/json', 'Accept-Language' => 'en-US,en;q=0.5'], $options->toArray()['headers']);`
	`50`	`+ $options->addHeader('Accept', 'application/html');`
	`51`	`+ $this->assertSame(['Accept' => 'application/html', 'Accept-Language' => 'en-US,en;q=0.5'], $options->toArray()['headers']);`
	`52`	`+ }`
`42`	`53`	`}`