[PHP] Add missing qualifier for enum parameters (#19567)

OpenAPITools · Sep 23, 2024 · 78f2f70 · 78f2f70
1 parent 98783f8
commit 78f2f70
Show file tree

Hide file tree

Showing 24 changed files with 1,450 additions and 160 deletions.
diff --git a/...penapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java b/...penapi-generator/src/main/java/org/openapitools/codegen/languages/AbstractPhpCodegen.java
@@ -18,6 +18,7 @@
 
 import io.swagger.v3.oas.models.media.Schema;
 import io.swagger.v3.oas.models.media.StringSchema;
+import io.swagger.v3.oas.models.parameters.Parameter;
 import lombok.Getter;
 import lombok.Setter;
 import org.apache.commons.io.FilenameUtils;
@@ -384,6 +385,11 @@ public String getTypeDeclaration(String name) {
         return super.getTypeDeclaration(name);
     }
 
+    @Override
+    protected String getParameterDataType(Parameter parameter, Schema schema) {
+        return getTypeDeclaration(schema);
+    }
+
     @Override
     public String getSchemaType(Schema p) {
         String openAPIType = super.getSchemaType(p);

diff --git a/...r/src/test/resources/3_0/php-nextgen/petstore-with-fake-endpoints-models-for-testing.yaml b/...r/src/test/resources/3_0/php-nextgen/petstore-with-fake-endpoints-models-for-testing.yaml
@@ -1303,6 +1303,42 @@ paths:
       responses:
         200:
           description: The instance started successfully
+  /fake/enum/endpoint:
+    get:
+      tags:
+        - fake
+      summary: test endpoint with enum parameter
+      operationId: fake-enum-endpoint
+      parameters:
+        - name: enum-class
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+              $ref: '#/components/schemas/EnumClass'
+        - name: enum-class-array
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/EnumClass'
+        - name: enum-class-map
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+            type: object
+            additionalProperties:
+              $ref: '#/components/schemas/EnumClass'
+      responses:
+        200:
+          description: The instance started successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnumClass'
 servers:
   - url: 'http://{server}.swagger.io:{port}/v2'
     description: petstore server

diff --git a/...generator/src/test/resources/3_0/php/petstore-with-fake-endpoints-models-for-testing.yaml b/...generator/src/test/resources/3_0/php/petstore-with-fake-endpoints-models-for-testing.yaml
@@ -1327,6 +1327,42 @@ paths:
       responses:
         200:
           description: OK
+  /fake/enum/endpoint:
+    get:
+      tags:
+        - fake
+      summary: test endpoint with enum parameter
+      operationId: fake-enum-endpoint
+      parameters:
+        - name: enum-class
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+            $ref: '#/components/schemas/EnumClass'
+        - name: enum-class-array
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+            type: array
+            items:
+              $ref: '#/components/schemas/EnumClass'
+        - name: enum-class-map
+          in: query
+          description: enum class parameter
+          required: true
+          schema:
+            type: object
+            additionalProperties:
+              $ref: '#/components/schemas/EnumClass'
+      responses:
+        200:
+          description: The instance started successfully
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EnumClass'
 servers:
   - url: 'http://{server}.swagger.io:{port}/v2'
     description: petstore server

diff --git a/samples/client/echo_api/php-nextgen-streaming/docs/Api/HeaderApi.md b/samples/client/echo_api/php-nextgen-streaming/docs/Api/HeaderApi.md
@@ -34,7 +34,7 @@ $integer_header = 56; // int
 $boolean_header = True; // bool
 $string_header = 'string_header_example'; // string
 $enum_nonref_string_header = 'enum_nonref_string_header_example'; // string
-$enum_ref_string_header = new \OpenAPI\Client\Model\StringEnumRef(); // StringEnumRef
+$enum_ref_string_header = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\StringEnumRef(); // \OpenAPI\Client\Model\StringEnumRef
 
 try {
     $result = $apiInstance->testHeaderIntegerBooleanStringEnums($integer_header, $boolean_header, $string_header, $enum_nonref_string_header, $enum_ref_string_header);
@@ -52,7 +52,7 @@ try {
 | **boolean_header** | **bool**|  | [optional] |
 | **string_header** | **string**|  | [optional] |
 | **enum_nonref_string_header** | **string**|  | [optional] |
-| **enum_ref_string_header** | [**StringEnumRef**](../Model/.md)|  | [optional] |
+| **enum_ref_string_header** | [**\OpenAPI\Client\Model\StringEnumRef**](../Model/.md)|  | [optional] |
 
 ### Return type
 

diff --git a/samples/client/echo_api/php-nextgen-streaming/docs/Api/PathApi.md b/samples/client/echo_api/php-nextgen-streaming/docs/Api/PathApi.md
@@ -33,7 +33,7 @@ $apiInstance = new OpenAPI\Client\Api\PathApi(
 $path_string = 'path_string_example'; // string
 $path_integer = 56; // int
 $enum_nonref_string_path = 'enum_nonref_string_path_example'; // string
-$enum_ref_string_path = new \OpenAPI\Client\Model\StringEnumRef(); // StringEnumRef
+$enum_ref_string_path = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\StringEnumRef(); // \OpenAPI\Client\Model\StringEnumRef
 
 try {
     $result = $apiInstance->testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath($path_string, $path_integer, $enum_nonref_string_path, $enum_ref_string_path);
@@ -50,7 +50,7 @@ try {
 | **path_string** | **string**|  | |
 | **path_integer** | **int**|  | |
 | **enum_nonref_string_path** | **string**|  | |
-| **enum_ref_string_path** | [**StringEnumRef**](../Model/.md)|  | |
+| **enum_ref_string_path** | [**\OpenAPI\Client\Model\StringEnumRef**](../Model/.md)|  | |
 
 ### Return type
 

diff --git a/samples/client/echo_api/php-nextgen-streaming/docs/Api/QueryApi.md b/samples/client/echo_api/php-nextgen-streaming/docs/Api/QueryApi.md
@@ -40,7 +40,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     new GuzzleHttp\Client()
 );
 $enum_nonref_string_query = 'enum_nonref_string_query_example'; // string
-$enum_ref_string_query = new \OpenAPI\Client\Model\StringEnumRef(); // StringEnumRef
+$enum_ref_string_query = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\StringEnumRef(); // \OpenAPI\Client\Model\StringEnumRef
 
 try {
     $result = $apiInstance->testEnumRefString($enum_nonref_string_query, $enum_ref_string_query);
@@ -55,7 +55,7 @@ try {
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
 | **enum_nonref_string_query** | **string**|  | [optional] |
-| **enum_ref_string_query** | [**StringEnumRef**](../Model/.md)|  | [optional] |
+| **enum_ref_string_query** | [**\OpenAPI\Client\Model\StringEnumRef**](../Model/.md)|  | [optional] |
 
 ### Return type
 
@@ -217,7 +217,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$query_object = new \OpenAPI\Client\Model\Pet(); // Pet
+$query_object = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet
 
 try {
     $result = $apiInstance->testQueryStyleDeepObjectExplodeTrueObject($query_object);
@@ -231,7 +231,7 @@ try {
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **query_object** | [**Pet**](../Model/.md)|  | [optional] |
+| **query_object** | [**\OpenAPI\Client\Model\Pet**](../Model/.md)|  | [optional] |
 
 ### Return type
 
@@ -273,7 +273,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$query_object = new \OpenAPI\Client\Model\TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter(); // TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
+$query_object = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter(); // \OpenAPI\Client\Model\TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
 
 try {
     $result = $apiInstance->testQueryStyleDeepObjectExplodeTrueObjectAllOf($query_object);
@@ -287,7 +287,7 @@ try {
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **query_object** | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter**](../Model/.md)|  | [optional] |
+| **query_object** | [**\OpenAPI\Client\Model\TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter**](../Model/.md)|  | [optional] |
 
 ### Return type
 
@@ -441,7 +441,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$query_object = new \OpenAPI\Client\Model\TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter(); // TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
+$query_object = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter(); // \OpenAPI\Client\Model\TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
 
 try {
     $result = $apiInstance->testQueryStyleFormExplodeTrueArrayString($query_object);
@@ -455,7 +455,7 @@ try {
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **query_object** | [**TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter**](../Model/.md)|  | [optional] |
+| **query_object** | [**\OpenAPI\Client\Model\TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter**](../Model/.md)|  | [optional] |
 
 ### Return type
 
@@ -497,7 +497,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$query_object = new \OpenAPI\Client\Model\Pet(); // Pet
+$query_object = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet
 
 try {
     $result = $apiInstance->testQueryStyleFormExplodeTrueObject($query_object);
@@ -511,7 +511,7 @@ try {
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **query_object** | [**Pet**](../Model/.md)|  | [optional] |
+| **query_object** | [**\OpenAPI\Client\Model\Pet**](../Model/.md)|  | [optional] |
 
 ### Return type
 
@@ -553,7 +553,7 @@ $apiInstance = new OpenAPI\Client\Api\QueryApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$query_object = new \OpenAPI\Client\Model\DataQuery(); // DataQuery
+$query_object = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\DataQuery(); // \OpenAPI\Client\Model\DataQuery
 
 try {
     $result = $apiInstance->testQueryStyleFormExplodeTrueObjectAllOf($query_object);
@@ -567,7 +567,7 @@ try {
 
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
-| **query_object** | [**DataQuery**](../Model/.md)|  | [optional] |
+| **query_object** | [**\OpenAPI\Client\Model\DataQuery**](../Model/.md)|  | [optional] |
 
 ### Return type
 

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
@@ -132,7 +132,7 @@ public function getConfig(): Configuration
      * @param  bool|null $boolean_header boolean_header (optional)
      * @param  string|null $string_header string_header (optional)
      * @param  string|null $enum_nonref_string_header enum_nonref_string_header (optional)
-     * @param  StringEnumRef|null $enum_ref_string_header enum_ref_string_header (optional)
+     * @param  \OpenAPI\Client\Model\StringEnumRef|null $enum_ref_string_header enum_ref_string_header (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testHeaderIntegerBooleanStringEnums'] to see the possible values for this operation
      *
      * @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -144,7 +144,7 @@ public function testHeaderIntegerBooleanStringEnums(
         ?bool $boolean_header = null,
         ?string $string_header = null,
         ?string $enum_nonref_string_header = null,
-        ?StringEnumRef $enum_ref_string_header = null,
+        ?\OpenAPI\Client\Model\StringEnumRef $enum_ref_string_header = null,
         string $contentType = self::contentTypes['testHeaderIntegerBooleanStringEnums'][0]
     ): string
     {
@@ -161,7 +161,7 @@ public function testHeaderIntegerBooleanStringEnums(
      * @param  bool|null $boolean_header (optional)
      * @param  string|null $string_header (optional)
      * @param  string|null $enum_nonref_string_header (optional)
-     * @param  StringEnumRef|null $enum_ref_string_header (optional)
+     * @param  \OpenAPI\Client\Model\StringEnumRef|null $enum_ref_string_header (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testHeaderIntegerBooleanStringEnums'] to see the possible values for this operation
      *
      * @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -173,7 +173,7 @@ public function testHeaderIntegerBooleanStringEnumsWithHttpInfo(
         ?bool $boolean_header = null,
         ?string $string_header = null,
         ?string $enum_nonref_string_header = null,
-        ?StringEnumRef $enum_ref_string_header = null,
+        ?\OpenAPI\Client\Model\StringEnumRef $enum_ref_string_header = null,
         string $contentType = self::contentTypes['testHeaderIntegerBooleanStringEnums'][0]
     ): array
     {
@@ -296,7 +296,7 @@ public function testHeaderIntegerBooleanStringEnumsWithHttpInfo(
      * @param  bool|null $boolean_header (optional)
      * @param  string|null $string_header (optional)
      * @param  string|null $enum_nonref_string_header (optional)
-     * @param  StringEnumRef|null $enum_ref_string_header (optional)
+     * @param  \OpenAPI\Client\Model\StringEnumRef|null $enum_ref_string_header (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testHeaderIntegerBooleanStringEnums'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException
@@ -307,7 +307,7 @@ public function testHeaderIntegerBooleanStringEnumsAsync(
         ?bool $boolean_header = null,
         ?string $string_header = null,
         ?string $enum_nonref_string_header = null,
-        ?StringEnumRef $enum_ref_string_header = null,
+        ?\OpenAPI\Client\Model\StringEnumRef $enum_ref_string_header = null,
         string $contentType = self::contentTypes['testHeaderIntegerBooleanStringEnums'][0]
     ): PromiseInterface
     {
@@ -328,7 +328,7 @@ function ($response) {
      * @param  bool|null $boolean_header (optional)
      * @param  string|null $string_header (optional)
      * @param  string|null $enum_nonref_string_header (optional)
-     * @param  StringEnumRef|null $enum_ref_string_header (optional)
+     * @param  \OpenAPI\Client\Model\StringEnumRef|null $enum_ref_string_header (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testHeaderIntegerBooleanStringEnums'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException
@@ -389,7 +389,7 @@ function ($exception) {
      * @param  bool|null $boolean_header (optional)
      * @param  string|null $string_header (optional)
      * @param  string|null $enum_nonref_string_header (optional)
-     * @param  StringEnumRef|null $enum_ref_string_header (optional)
+     * @param  \OpenAPI\Client\Model\StringEnumRef|null $enum_ref_string_header (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testHeaderIntegerBooleanStringEnums'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException

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
@@ -131,7 +131,7 @@ public function getConfig(): Configuration
      * @param  string $path_string path_string (required)
      * @param  int $path_integer path_integer (required)
      * @param  string $enum_nonref_string_path enum_nonref_string_path (required)
-     * @param  StringEnumRef $enum_ref_string_path enum_ref_string_path (required)
+     * @param  \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path enum_ref_string_path (required)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'] to see the possible values for this operation
      *
      * @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -142,7 +142,7 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
         string $path_string,
         int $path_integer,
         string $enum_nonref_string_path,
-        StringEnumRef $enum_ref_string_path,
+        \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path,
         string $contentType = self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'][0]
     ): string
     {
@@ -158,7 +158,7 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
      * @param  string $path_string (required)
      * @param  int $path_integer (required)
      * @param  string $enum_nonref_string_path (required)
-     * @param  StringEnumRef $enum_ref_string_path (required)
+     * @param  \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path (required)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'] to see the possible values for this operation
      *
      * @throws ApiException on non-2xx response or if the response body is not in the expected format
@@ -169,7 +169,7 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
         string $path_string,
         int $path_integer,
         string $enum_nonref_string_path,
-        StringEnumRef $enum_ref_string_path,
+        \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path,
         string $contentType = self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'][0]
     ): array
     {
@@ -291,7 +291,7 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
      * @param  string $path_string (required)
      * @param  int $path_integer (required)
      * @param  string $enum_nonref_string_path (required)
-     * @param  StringEnumRef $enum_ref_string_path (required)
+     * @param  \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path (required)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException
@@ -301,7 +301,7 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
         string $path_string,
         int $path_integer,
         string $enum_nonref_string_path,
-        StringEnumRef $enum_ref_string_path,
+        \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path,
         string $contentType = self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'][0]
     ): PromiseInterface
     {
@@ -321,7 +321,7 @@ function ($response) {
      * @param  string $path_string (required)
      * @param  int $path_integer (required)
      * @param  string $enum_nonref_string_path (required)
-     * @param  StringEnumRef $enum_ref_string_path (required)
+     * @param  \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path (required)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException
@@ -380,7 +380,7 @@ function ($exception) {
      * @param  string $path_string (required)
      * @param  int $path_integer (required)
      * @param  string $enum_nonref_string_path (required)
-     * @param  StringEnumRef $enum_ref_string_path (required)
+     * @param  \OpenAPI\Client\Model\StringEnumRef $enum_ref_string_path (required)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath'] to see the possible values for this operation
      *
      * @throws InvalidArgumentException