Skip to content

[PHP][php-nextgen] List all possible return types (fix #17113) #20335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 2 commits into from
Dec 21, 2024
Merged

[PHP][php-nextgen] List all possible return types (fix #17113) #20335

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
16dfa51
[PHP][php-nextgen] List all possible return types (fix #17113)
JulianVennen Dec 15, 2024
a9987e5
Switch to LinkedHashSet
JulianVennen Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions ...i-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
JulianVennen marked this conversation as resolved.
Outdated
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) {
Expand Down
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down