[PHP] Allows setting extra request options via config

modules/openapi-generator/src/main/resources/php/Configuration.mustache

@@ -104,6 +104,13 @@ class Configuration
      */
     protected $tempFolderPath;
 
+    /**
+     * Holds any extra request options you want to send
+     *
+     * @var array
+     */
+    protected $options = [];
+
     /**
      * Constructor
      */
@@ -500,4 +507,26 @@ class Configuration
 
         return $url;
     }
+
+    /**
+     * Set extra request options
+     *
+     * @param array $options
+     * @return $this
+     */
+    public function setOptions(array $options)
+    {
+        $this->options = $options;
+        return $this;
+    }
+
+    /**
+     * Get extra request options
+     *
+     * @return array
+     */
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
 }

modules/openapi-generator/src/main/resources/php/api.mustache

@@ -686,7 +686,7 @@ use {{invokerPackage}}\ObjectSerializer;
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/AnotherFakeApi.php

@@ -392,7 +392,7 @@ public function call123TestSpecialTagsRequest($client)
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/DefaultApi.php

@@ -367,7 +367,7 @@ public function fooGetRequest()
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/FakeApi.php

@@ -4691,7 +4691,7 @@ public function testQueryParameterCollectionFormatRequest($pipe, $ioutil, $http,
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/FakeClassnameTags123Api.php

@@ -397,7 +397,7 @@ public function testClassnameRequest($client)
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/PetApi.php

@@ -2556,7 +2556,7 @@ public function uploadFileWithRequiredFileRequest($pet_id, $required_file, $addi
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/StoreApi.php

@@ -1153,7 +1153,7 @@ public function placeOrderRequest($order)
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Api/UserApi.php

@@ -2038,7 +2038,7 @@ public function updateUserRequest($username, $user)
      */
     protected function createHttpClientOption()
     {
-        $options = [];
+        $options = $this->config->getOptions();
         if ($this->config->getDebug()) {
             $options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
             if (!$options[RequestOptions::DEBUG]) {

samples/client/petstore/php/OpenAPIClient-php/lib/Configuration.php

@@ -113,6 +113,13 @@ class Configuration
      */
     protected $tempFolderPath;
 
+    /**
+     * Holds any extra request options you want to send
+     *
+     * @var array
+     */
+    protected $options = [];
+
     /**
      * Constructor
      */
@@ -520,4 +527,26 @@ public function getHostFromSettings($index, $variables = null)
 
         return $url;
     }
+
+    /**
+     * Set extra request options
+     *
+     * @param array $options
+     * @return $this
+     */
+    public function setOptions(array $options)
+    {
+        $this->options = $options;
+        return $this;
+    }
+
+    /**
+     * Get extra request options
+     *
+     * @return array
+     */
+    public function getOptions(): array
+    {
+        return $this->options;
+    }
 }

samples/client/petstore/php/OpenAPIClient-php/tests/ConfigurationTest.php

@@ -5,6 +5,9 @@
 use GuzzleHttp\Client;
 use PHPUnit\Framework\TestCase;
 
+/**
+ * @coversDefaultClass \OpenAPI\Client\Configuration
+ */
 class ConfigurationTest extends TestCase
 {
     /**
@@ -64,4 +67,33 @@ public function testHostUrlWithInvalidValues()
         $url = $config->getHostFromSettings(0, array("server" => "dev-petstore", "port" => "8"));
         $this->assertSame("http://dev-petstore.swagger.io:8080/v2", $url);
     }
+
+    /**
+     * Tests additional http client options.
+     *
+     * @see https://github.com/OpenAPITools/openapi-generator/pull/11431
+     * @covers ::setOptions
+     * @covers ::getOptions
+     */
+    public function testHttpClientOptions()
+    {
+        $config = Configuration::getDefaultConfiguration();
+        // default is array and empty
+        $this->assertIsArray($config->getOptions());
+        $this->assertEmpty($config->getOptions());
+
+        // example from PR itself
+        $cookie = \GuzzleHttp\Cookie\CookieJar::fromArray([
+            'XDEBUG_SESSION' => 'xdebug',
+        ], 'example.com');
+
+        $self = $config->setOptions(['cookies' => $cookie]);
+        // assert method is chainable
+        $this->assertInstanceOf(Configuration::class, $self);
+
+        // still array, not empty
+        $options = $config->getOptions();
+        $this->assertIsArray($options);
+        $this->assertArrayHasKey('cookies', $options);
+    }
 }