[PHP][php-nextgen] Improve method parameter typing (#20361)

* Fix #20354 - Nullable mixed type is not allowed * Add parameter types for request and asyncWithHttpInfo functions
OpenAPITools · Dec 21, 2024 · eceef28 · eceef28
1 parent 806b99e
commit eceef28
Show file tree

Hide file tree

Showing 18 changed files with 384 additions and 380 deletions.
diff --git a/...i-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java b/...i-generator/src/main/java/org/openapitools/codegen/languages/PhpNextgenClientCodegen.java
@@ -214,7 +214,11 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
                 if (param.isArray || param.isMap) {
                     param.vendorExtensions.putIfAbsent("x-php-param-type", "array");
                 } else {
-                    param.vendorExtensions.putIfAbsent("x-php-param-type", param.dataType);
+                    String paramType = param.dataType;
+                    if ((!param.required || param.isNullable) && !paramType.equals("mixed")) { // optional or nullable but not mixed
+                        paramType = "?" + paramType;
+                    }
+                    param.vendorExtensions.putIfAbsent("x-php-param-type", paramType);
                 }
             }
         }

diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
@@ -172,7 +172,7 @@ use {{invokerPackage}}\ObjectSerializer;
     public function {{operationId}}(
     {{^vendorExtensions.x-group-parameters}}
     {{#allParams}}
-        {{^required}}?{{/required}}{{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
+        {{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
     {{/allParams}}
     {{#servers}}
     {{#-first}}
@@ -247,7 +247,7 @@ use {{invokerPackage}}\ObjectSerializer;
     public function {{operationId}}WithHttpInfo(
     {{^vendorExtensions.x-group-parameters}}
     {{#allParams}}
-        {{^required}}?{{/required}}{{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
+        {{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
     {{/allParams}}
     {{#servers}}
     {{#-first}}
@@ -446,7 +446,7 @@ use {{invokerPackage}}\ObjectSerializer;
     public function {{operationId}}Async(
     {{^vendorExtensions.x-group-parameters}}
     {{#allParams}}
-        {{^required}}?{{/required}}{{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
+        {{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
     {{/allParams}}
     {{#servers}}
     {{#-first}}
@@ -524,7 +524,7 @@ use {{invokerPackage}}\ObjectSerializer;
     public function {{operationId}}AsyncWithHttpInfo(
     {{^vendorExtensions.x-group-parameters}}
     {{#allParams}}
-        ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
+        {{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
     {{/allParams}}
     {{#servers}}
     {{#-first}}
@@ -630,7 +630,7 @@ use {{invokerPackage}}\ObjectSerializer;
     public function {{operationId}}Request(
     {{^vendorExtensions.x-group-parameters}}
     {{#allParams}}
-        ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
+        {{vendorExtensions.x-php-param-type}} ${{paramName}}{{^required}} = {{#defaultValue}}{{{.}}}{{/defaultValue}}{{^defaultValue}}null{{/defaultValue}}{{/required}},
     {{/allParams}}
     {{#servers}}
     {{#-first}}

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/BodyApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/BodyApi.php
@@ -633,7 +633,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testBodyApplicationOctetstreamBinaryAsyncWithHttpInfo(
-        $body = null,
+        ?\Psr\Http\Message\StreamInterface $body = null,
         string $contentType = self::contentTypes['testBodyApplicationOctetstreamBinary'][0]
     ): PromiseInterface
     {
@@ -686,7 +686,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testBodyApplicationOctetstreamBinaryRequest(
-        $body = null,
+        ?\Psr\Http\Message\StreamInterface $body = null,
         string $contentType = self::contentTypes['testBodyApplicationOctetstreamBinary'][0]
     ): Request
     {
@@ -949,7 +949,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testBodyMultipartFormdataArrayOfBinaryAsyncWithHttpInfo(
-        $files,
+        array $files,
         string $contentType = self::contentTypes['testBodyMultipartFormdataArrayOfBinary'][0]
     ): PromiseInterface
     {
@@ -1002,7 +1002,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testBodyMultipartFormdataArrayOfBinaryRequest(
-        $files,
+        array $files,
         string $contentType = self::contentTypes['testBodyMultipartFormdataArrayOfBinary'][0]
     ): Request
     {
@@ -1278,7 +1278,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testBodyMultipartFormdataSingleBinaryAsyncWithHttpInfo(
-        $my_file = null,
+        ?\Psr\Http\Message\StreamInterface $my_file = null,
         string $contentType = self::contentTypes['testBodyMultipartFormdataSingleBinary'][0]
     ): PromiseInterface
     {
@@ -1331,7 +1331,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testBodyMultipartFormdataSingleBinaryRequest(
-        $my_file = null,
+        ?\Psr\Http\Message\StreamInterface $my_file = null,
         string $contentType = self::contentTypes['testBodyMultipartFormdataSingleBinary'][0]
     ): Request
     {
@@ -1601,7 +1601,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyAllOfPetAsyncWithHttpInfo(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyAllOfPet'][0]
     ): PromiseInterface
     {
@@ -1654,7 +1654,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyAllOfPetRequest(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyAllOfPet'][0]
     ): Request
     {
@@ -1745,7 +1745,7 @@ public function testEchoBodyAllOfPetRequest(
      * @return string
      */
     public function testEchoBodyFreeFormObjectResponseString(
-        ?array $body = null,
+        array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][0]
     ): string
     {
@@ -1766,7 +1766,7 @@ public function testEchoBodyFreeFormObjectResponseString(
      * @return array of string, HTTP status code, HTTP response headers (array of strings)
      */
     public function testEchoBodyFreeFormObjectResponseStringWithHttpInfo(
-        ?array $body = null,
+        array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][0]
     ): array
     {
@@ -1893,7 +1893,7 @@ public function testEchoBodyFreeFormObjectResponseStringWithHttpInfo(
      * @return PromiseInterface
      */
     public function testEchoBodyFreeFormObjectResponseStringAsync(
-        ?array $body = null,
+        array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][0]
     ): PromiseInterface
     {
@@ -1917,7 +1917,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyFreeFormObjectResponseStringAsyncWithHttpInfo(
-        $body = null,
+        array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][0]
     ): PromiseInterface
     {
@@ -1970,7 +1970,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyFreeFormObjectResponseStringRequest(
-        $body = null,
+        array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][0]
     ): Request
     {
@@ -2233,7 +2233,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyPetAsyncWithHttpInfo(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyPet'][0]
     ): PromiseInterface
     {
@@ -2286,7 +2286,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyPetRequest(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyPet'][0]
     ): Request
     {
@@ -2549,7 +2549,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyPetResponseStringAsyncWithHttpInfo(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyPetResponseString'][0]
     ): PromiseInterface
     {
@@ -2602,7 +2602,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyPetResponseStringRequest(
-        $pet = null,
+        ?\OpenAPI\Client\Model\Pet $pet = null,
         string $contentType = self::contentTypes['testEchoBodyPetResponseString'][0]
     ): Request
     {
@@ -2865,7 +2865,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyStringEnumAsyncWithHttpInfo(
-        $body = null,
+        ?string $body = null,
         string $contentType = self::contentTypes['testEchoBodyStringEnum'][0]
     ): PromiseInterface
     {
@@ -2918,7 +2918,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyStringEnumRequest(
-        $body = null,
+        ?string $body = null,
         string $contentType = self::contentTypes['testEchoBodyStringEnum'][0]
     ): Request
     {
@@ -3181,7 +3181,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testEchoBodyTagResponseStringAsyncWithHttpInfo(
-        $tag = null,
+        ?\OpenAPI\Client\Model\Tag $tag = null,
         string $contentType = self::contentTypes['testEchoBodyTagResponseString'][0]
     ): PromiseInterface
     {
@@ -3234,7 +3234,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testEchoBodyTagResponseStringRequest(
-        $tag = null,
+        ?\OpenAPI\Client\Model\Tag $tag = null,
         string $contentType = self::contentTypes['testEchoBodyTagResponseString'][0]
     ): Request
     {

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/FormApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/FormApi.php
@@ -328,9 +328,9 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testFormIntegerBooleanStringAsyncWithHttpInfo(
-        $integer_form = null,
-        $boolean_form = null,
-        $string_form = null,
+        ?int $integer_form = null,
+        ?bool $boolean_form = null,
+        ?string $string_form = null,
         string $contentType = self::contentTypes['testFormIntegerBooleanString'][0]
     ): PromiseInterface
     {
@@ -385,9 +385,9 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testFormIntegerBooleanStringRequest(
-        $integer_form = null,
-        $boolean_form = null,
-        $string_form = null,
+        ?int $integer_form = null,
+        ?bool $boolean_form = null,
+        ?string $string_form = null,
         string $contentType = self::contentTypes['testFormIntegerBooleanString'][0]
     ): Request
     {
@@ -657,7 +657,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testFormObjectMultipartAsyncWithHttpInfo(
-        $marker,
+        \OpenAPI\Client\Model\TestFormObjectMultipartRequestMarker $marker,
         string $contentType = self::contentTypes['testFormObjectMultipart'][0]
     ): PromiseInterface
     {
@@ -710,7 +710,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testFormObjectMultipartRequest(
-        $marker,
+        \OpenAPI\Client\Model\TestFormObjectMultipartRequestMarker $marker,
         string $contentType = self::contentTypes['testFormObjectMultipart'][0]
     ): Request
     {
@@ -1011,12 +1011,12 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testFormOneofAsyncWithHttpInfo(
-        $form1 = null,
-        $form2 = null,
-        $form3 = null,
-        $form4 = null,
-        $id = null,
-        $name = null,
+        ?string $form1 = null,
+        ?int $form2 = null,
+        ?string $form3 = null,
+        ?bool $form4 = null,
+        ?int $id = null,
+        ?string $name = null,
         string $contentType = self::contentTypes['testFormOneof'][0]
     ): PromiseInterface
     {
@@ -1074,12 +1074,12 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testFormOneofRequest(
-        $form1 = null,
-        $form2 = null,
-        $form3 = null,
-        $form4 = null,
-        $id = null,
-        $name = null,
+        ?string $form1 = null,
+        ?int $form2 = null,
+        ?string $form3 = null,
+        ?bool $form4 = null,
+        ?int $id = null,
+        ?string $name = null,
         string $contentType = self::contentTypes['testFormOneof'][0]
     ): Request
     {

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/HeaderApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/HeaderApi.php
@@ -336,11 +336,11 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testHeaderIntegerBooleanStringEnumsAsyncWithHttpInfo(
-        $integer_header = null,
-        $boolean_header = null,
-        $string_header = null,
-        $enum_nonref_string_header = null,
-        $enum_ref_string_header = null,
+        ?int $integer_header = null,
+        ?bool $boolean_header = null,
+        ?string $string_header = null,
+        ?string $enum_nonref_string_header = null,
+        ?\OpenAPI\Client\Model\StringEnumRef $enum_ref_string_header = null,
         string $contentType = self::contentTypes['testHeaderIntegerBooleanStringEnums'][0]
     ): PromiseInterface
     {
@@ -397,11 +397,11 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testHeaderIntegerBooleanStringEnumsRequest(
-        $integer_header = null,
-        $boolean_header = null,
-        $string_header = null,
-        $enum_nonref_string_header = null,
-        $enum_ref_string_header = null,
+        ?int $integer_header = null,
+        ?bool $boolean_header = null,
+        ?string $string_header = null,
+        ?string $enum_nonref_string_header = null,
+        ?\OpenAPI\Client\Model\StringEnumRef $enum_ref_string_header = null,
         string $contentType = self::contentTypes['testHeaderIntegerBooleanStringEnums'][0]
     ): Request
     {

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/PathApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/PathApi.php
@@ -329,10 +329,10 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathAsyncWithHttpInfo(
-        $path_string,
-        $path_integer,
-        $enum_nonref_string_path,
-        $enum_ref_string_path,
+        string $path_string,
+        int $path_integer,
+        string $enum_nonref_string_path,
+        \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path,
         string $contentType = self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'][0]
     ): PromiseInterface
     {
@@ -388,10 +388,10 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPathRequest(
-        $path_string,
-        $path_integer,
-        $enum_nonref_string_path,
-        $enum_ref_string_path,
+        string $path_string,
+        int $path_integer,
+        string $enum_nonref_string_path,
+        \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path,
         string $contentType = self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'][0]
     ): Request
     {