From 16dfa512e28fb4fe1c6097312dd086e4b0ef4b0a Mon Sep 17 00:00:00 2001
From: Julian Vennen <julian@vennen.me>
Date: Sun, 15 Dec 2024 17:00:41 +0100
Subject: [PATCH 1/2] [PHP][php-nextgen] List all possible return types (fix
 #17113)

---
 .../languages/PhpNextgenClientCodegen.java    | 33 +++++++++++++++----
 .../main/resources/php-nextgen/api.mustache   |  2 +-
 2 files changed, 28 insertions(+), 7 deletions(-)

diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
index 6f79932b56fe..6bb96a5b7304 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
@@ -189,14 +189,35 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
         objs = super.postProcessOperationsWithModels(objs, allModels);
         OperationMap operations = objs.getOperations();
         for (CodegenOperation operation : operations.getOperation()) {
-            if (operation.returnType == null) {
+            // Once we upgrade to java 21 we can use SequencedSet instead
+            List<String> phpReturnTypeOptions = new ArrayList<>();
+            List<String> docReturnTypeOptions = new ArrayList<>();
+
+            for (CodegenResponse response : operation.responses) {
+                if (response.dataType != null) {
+                    String returnType = response.dataType;
+                    if (response.isArray || response.isMap) {
+                        // PHP does not understand array type hinting so we strip it
+                        // The phpdoc will still contain the array type hinting
+                        returnType = "array";
+                    }
+
+                    if (!phpReturnTypeOptions.contains(returnType)) {
+                        phpReturnTypeOptions.add(returnType);
+                    }
+
+                    if (!docReturnTypeOptions.contains(response.dataType)) {
+                        docReturnTypeOptions.add(response.dataType);
+                    }
+                }
+            }
+
+            if (phpReturnTypeOptions.isEmpty()) {
                 operation.vendorExtensions.putIfAbsent("x-php-return-type", "void");
+                operation.vendorExtensions.putIfAbsent("x-php-doc-return-type", "void");
             } else {
-                if (operation.returnProperty.isContainer) { // array or map
-                    operation.vendorExtensions.putIfAbsent("x-php-return-type", "array");
-                } else {
-                    operation.vendorExtensions.putIfAbsent("x-php-return-type", operation.returnType);
-                }
+                operation.vendorExtensions.putIfAbsent("x-php-return-type", String.join("|", phpReturnTypeOptions));
+                operation.vendorExtensions.putIfAbsent("x-php-doc-return-type", String.join("|", docReturnTypeOptions));
             }
 
             for (CodegenParameter param : operation.allParams) {
diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
index 006cbbc7523e..8b01cbe0f79b 100644
--- a/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
@@ -164,7 +164,7 @@ use {{invokerPackage}}\ObjectSerializer;
      *
      * @throws ApiException on non-2xx response or if the response body is not in the expected format
      * @throws InvalidArgumentException
-     * @return {{#returnType}}{{#responses}}{{#dataType}}{{^-first}}|{{/-first}}{{/dataType}}{{{dataType}}}{{/responses}}{{/returnType}}{{^returnType}}void{{/returnType}}
+     * @return {{{vendorExtensions.x-php-doc-return-type}}}
     {{#isDeprecated}}
      * @deprecated
     {{/isDeprecated}}

From a9987e5739dd260ccf10c7ef69991503f6e252d0 Mon Sep 17 00:00:00 2001
From: Julian Vennen <julian@vennen.me>
Date: Fri, 20 Dec 2024 13:32:26 +0100
Subject: [PATCH 2/2] Switch to LinkedHashSet

---
 .../languages/PhpNextgenClientCodegen.java    | 20 +++++--------------
 1 file changed, 5 insertions(+), 15 deletions(-)

diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
index 6bb96a5b7304..55c3cb95d106 100644
--- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
+++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
@@ -34,11 +34,7 @@
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.EnumSet;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 public class PhpNextgenClientCodegen extends AbstractPhpCodegen {
     @SuppressWarnings("hiding")
@@ -189,9 +185,8 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
         objs = super.postProcessOperationsWithModels(objs, allModels);
         OperationMap operations = objs.getOperations();
         for (CodegenOperation operation : operations.getOperation()) {
-            // Once we upgrade to java 21 we can use SequencedSet instead
-            List<String> phpReturnTypeOptions = new ArrayList<>();
-            List<String> docReturnTypeOptions = new ArrayList<>();
+            Set<String> phpReturnTypeOptions = new LinkedHashSet<>();
+            Set<String> docReturnTypeOptions = new LinkedHashSet<>();
 
             for (CodegenResponse response : operation.responses) {
                 if (response.dataType != null) {
@@ -202,13 +197,8 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                         returnType = "array";
                     }
 
-                    if (!phpReturnTypeOptions.contains(returnType)) {
-                        phpReturnTypeOptions.add(returnType);
-                    }
-
-                    if (!docReturnTypeOptions.contains(response.dataType)) {
-                        docReturnTypeOptions.add(response.dataType);
-                    }
+                    phpReturnTypeOptions.add(returnType);
+                    docReturnTypeOptions.add(response.dataType);
                 }
             }