[php-*] Explicitly declare nullable parameters (#20524)

* [php-nextgen] Explicitly declare nullable parameters explicitly * Fix some deprecation warnings in other php generators * [php-nextgen] Fix PHP 8.4 deprecation warnings with nullable/optional array parameters
OpenAPITools · Jan 23, 2025 · a68ad56 · a68ad56
1 parent ad8de61
commit a68ad56
Show file tree

Hide file tree

Showing 104 changed files with 209 additions and 208 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
@@ -211,15 +211,16 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             }
 
             for (CodegenParameter param : operation.allParams) {
+                String paramType;
                 if (param.isArray || param.isMap) {
-                    param.vendorExtensions.putIfAbsent("x-php-param-type", "array");
+                    paramType = "array";
                 } else {
-                    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);
+                    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-dt-modern/ApiClientFactory.php.mustache b/modules/openapi-generator/src/main/resources/php-dt-modern/ApiClientFactory.php.mustache
@@ -16,7 +16,7 @@ class ApiClientFactory implements PM\ServiceFactoryInterface
         $this->configKey = $configKey;
     }
 
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): ApiClient
+    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): ApiClient
     {
         $config = new OAGAC\ApiClientOptions(\array_merge($this->getServiceConfig($container), $options ?? []));
         return new ApiClient(

diff --git a/modules/openapi-generator/src/main/resources/php-dt/ApiClientFactory.php.mustache b/modules/openapi-generator/src/main/resources/php-dt/ApiClientFactory.php.mustache
@@ -16,7 +16,7 @@ class ApiClientFactory implements PM\ServiceFactoryInterface
         $this->configKey = $configKey;
     }
 
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): ApiClient
+    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): ApiClient
     {
         $config = new OAGAC\ApiClientOptions(\array_merge($this->getServiceConfig($container), $options ?? []));
         return new ApiClient(

diff --git a/modules/openapi-generator/src/main/resources/php-mezzio-ph-modern/Factory.php.mustache b/modules/openapi-generator/src/main/resources/php-mezzio-ph-modern/Factory.php.mustache
@@ -21,7 +21,7 @@ use Laminas\Stratigility\MiddlewarePipe;
 
 class Factory implements FactoryInterface
 {
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): Application
+    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): Application
     {
         $errorMiddleware = self::getErrorMiddleware($container);
         $pipeline = new MiddlewarePipe();

diff --git a/modules/openapi-generator/src/main/resources/php-mezzio-ph/Factory.php.mustache b/modules/openapi-generator/src/main/resources/php-mezzio-ph/Factory.php.mustache
@@ -21,7 +21,7 @@ use Laminas\Stratigility\MiddlewarePipe;
 
 class Factory implements FactoryInterface
 {
-    public function __invoke(ContainerInterface $container, $requestedName, array $options = null): Application
+    public function __invoke(ContainerInterface $container, $requestedName, ?array $options = null): Application
     {
         $errorMiddleware = self::getErrorMiddleware($container);
         $pipeline = new MiddlewarePipe();

diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/Configuration.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/Configuration.mustache
@@ -498,7 +498,7 @@ class Configuration
     * @param array|null $variables    hash of variable and the corresponding value (optional)
     * @return string URL based on host settings
     */
-    public static function getHostString(array $hostSettings, int $hostIndex, array $variables = null): string
+    public static function getHostString(array $hostSettings, int $hostIndex, ?array $variables = null): string
     {
         if (null === $variables) {
             $variables = [];

diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/ObjectSerializer.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/ObjectSerializer.mustache
@@ -56,7 +56,7 @@ class ObjectSerializer
      *
      * @return scalar|object|array|null serialized form of $data
      */
-    public static function sanitizeForSerialization(mixed $data, string $type = null, string $format = null): mixed
+    public static function sanitizeForSerialization(mixed $data, ?string $type = null, ?string $format = null): mixed
     {
         if (is_scalar($data) || null === $data) {
             return $data;
@@ -388,7 +388,7 @@ class ObjectSerializer
      *
      * @return mixed a single or an array of $class instances
      */
-    public static function deserialize(mixed $data, string $class, array $httpHeaders = null): mixed
+    public static function deserialize(mixed $data, string $class, ?array $httpHeaders = null): mixed
     {
         if (null === $data) {
             return null;

diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
@@ -76,9 +76,9 @@ use {{invokerPackage}}\ObjectSerializer;
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();

diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/model_generic.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/model_generic.mustache
@@ -245,7 +245,7 @@ class {{classname}} {{#parentSchema}}extends {{{parent}}}{{/parentSchema}}{{^par
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         {{#discriminator}}
         // Initialize discriminator property with the model name.

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/AuthApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/AuthApi.php
@@ -87,9 +87,9 @@ class AuthApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();

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
@@ -111,9 +111,9 @@ class BodyApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();
@@ -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(
-        array $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(
-        array $body = null,
+        ?array $body = null,
         string $contentType = self::contentTypes['testEchoBodyFreeFormObjectResponseString'][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
@@ -90,9 +90,9 @@ class FormApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();

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
@@ -84,9 +84,9 @@ class HeaderApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();

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
@@ -84,9 +84,9 @@ class PathApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Api/QueryApi.php b/samples/client/echo_api/php-nextgen-streaming/src/Api/QueryApi.php
@@ -111,9 +111,9 @@ class QueryApi
      * @param int                  $hostIndex (Optional) host index to select the list of hosts if defined in the OpenAPI spec
      */
     public function __construct(
-        ClientInterface $client = null,
-        Configuration $config = null,
-        HeaderSelector $selector = null,
+        ?ClientInterface $client = null,
+        ?Configuration $config = null,
+        ?HeaderSelector $selector = null,
         int $hostIndex = 0
     ) {
         $this->client = $client ?: new Client();
@@ -1853,7 +1853,7 @@ public function testQueryStyleDeepObjectExplodeTrueObjectAllOfRequest(
      * @return string
      */
     public function testQueryStyleFormExplodeFalseArrayInteger(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0]
     ): string
     {
@@ -1874,7 +1874,7 @@ public function testQueryStyleFormExplodeFalseArrayInteger(
      * @return array of string, HTTP status code, HTTP response headers (array of strings)
      */
     public function testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0]
     ): array
     {
@@ -2001,7 +2001,7 @@ public function testQueryStyleFormExplodeFalseArrayIntegerWithHttpInfo(
      * @return PromiseInterface
      */
     public function testQueryStyleFormExplodeFalseArrayIntegerAsync(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0]
     ): PromiseInterface
     {
@@ -2025,7 +2025,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testQueryStyleFormExplodeFalseArrayIntegerAsyncWithHttpInfo(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0]
     ): PromiseInterface
     {
@@ -2078,7 +2078,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testQueryStyleFormExplodeFalseArrayIntegerRequest(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayInteger'][0]
     ): Request
     {
@@ -2171,7 +2171,7 @@ public function testQueryStyleFormExplodeFalseArrayIntegerRequest(
      * @return string
      */
     public function testQueryStyleFormExplodeFalseArrayString(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0]
     ): string
     {
@@ -2192,7 +2192,7 @@ public function testQueryStyleFormExplodeFalseArrayString(
      * @return array of string, HTTP status code, HTTP response headers (array of strings)
      */
     public function testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0]
     ): array
     {
@@ -2319,7 +2319,7 @@ public function testQueryStyleFormExplodeFalseArrayStringWithHttpInfo(
      * @return PromiseInterface
      */
     public function testQueryStyleFormExplodeFalseArrayStringAsync(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0]
     ): PromiseInterface
     {
@@ -2343,7 +2343,7 @@ function ($response) {
      * @return PromiseInterface
      */
     public function testQueryStyleFormExplodeFalseArrayStringAsyncWithHttpInfo(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0]
     ): PromiseInterface
     {
@@ -2396,7 +2396,7 @@ function ($exception) {
      * @return \GuzzleHttp\Psr7\Request
      */
     public function testQueryStyleFormExplodeFalseArrayStringRequest(
-        array $query_object = null,
+        ?array $query_object = null,
         string $contentType = self::contentTypes['testQueryStyleFormExplodeFalseArrayString'][0]
     ): Request
     {

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Configuration.php b/samples/client/echo_api/php-nextgen-streaming/src/Configuration.php
@@ -482,7 +482,7 @@ public function getHostSettings(): array
     * @param array|null $variables    hash of variable and the corresponding value (optional)
     * @return string URL based on host settings
     */
-    public static function getHostString(array $hostSettings, int $hostIndex, array $variables = null): string
+    public static function getHostString(array $hostSettings, int $hostIndex, ?array $variables = null): string
     {
         if (null === $variables) {
             $variables = [];

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/Bird.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/Bird.php
@@ -247,7 +247,7 @@ public function getModelName(): string
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('size', $data ?? [], null);
         $this->setIfExists('color', $data ?? [], null);

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/Category.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/Category.php
@@ -247,7 +247,7 @@ public function getModelName(): string
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('id', $data ?? [], null);
         $this->setIfExists('name', $data ?? [], null);

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/DataQuery.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/DataQuery.php
@@ -241,7 +241,7 @@ public function getModelName(): string
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         parent::__construct($data);
 

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/DefaultValue.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/DefaultValue.php
@@ -301,7 +301,7 @@ public function getArrayStringEnumDefaultAllowableValues()
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('array_string_enum_ref_default', $data ?? [], [["success","failure"]]);
         $this->setIfExists('array_string_enum_default', $data ?? [], [["success","failure"]]);

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/NumberPropertiesOnly.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/NumberPropertiesOnly.php
@@ -253,7 +253,7 @@ public function getModelName(): string
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('number', $data ?? [], null);
         $this->setIfExists('float', $data ?? [], null);

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/Pet.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/Pet.php
@@ -288,7 +288,7 @@ public function getStatusAllowableValues()
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('id', $data ?? [], null);
         $this->setIfExists('name', $data ?? [], null);

diff --git a/samples/client/echo_api/php-nextgen-streaming/src/Model/Query.php b/samples/client/echo_api/php-nextgen-streaming/src/Model/Query.php
@@ -264,7 +264,7 @@ public function getOutcomesAllowableValues()
      *
      * @param array $data Associated array of property values initializing the model
      */
-    public function __construct(array $data = null)
+    public function __construct(?array $data = null)
     {
         $this->setIfExists('id', $data ?? [], null);
         $this->setIfExists('outcomes', $data ?? [], [["SUCCESS","FAILURE"]]);