[php] Set minimal PHP version to ^8.0 (#14500)

* Set minimal PHP version to ^8.0 * Fix php-nextgen config * Change stability to BETA

[php] Set minimal PHP version to ^8.0 (#14500)
* Set minimal PHP version to ^8.0 * Fix php-nextgen config * Change stability to BETA
a4540fee · Yuriy Belenko · GitHub · 45368c2a · a4540fee · a4540fee
Unverified Commit a4540fee authored 2 years ago by Yuriy Belenko Committed by GitHub 2 years ago
Hide whitespace changes
Inline Side-by-side

Showing

with 308 additions and 33 deletions
+308 -33
--- a/bin/configs/php-nextgen.yaml
+++ b/bin/configs/php-nextgen.yaml
-generatorName: php
+generatorName: php-nextgen
 outputDir: samples/client/petstore/php-nextgen/OpenAPIClient-php
 inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
 templateDir: modules/openapi-generator/src/main/resources/php-nextgen
--- a/docs/generators.md
+++ b/docs/generators.md
@@ -49,6 +49,7 @@ The following generators are available:
 * [perl](generators/perl.md)  
 * [php](generators/php.md)  
 * [php-dt (beta)](generators/php-dt.md)  
+* [php-nextgen (beta)](generators/php-nextgen.md)  
 * [powershell (beta)](generators/powershell.md)  
 * [python](generators/python.md)  
 * [python-legacy](generators/python-legacy.md)  

--- a/docs/generators/php-nextgen.md
+++ b/docs/generators/php-nextgen.md
+---
+title: Documentation for the php-nextgen Generator
+---
+
+## METADATA
+
+| Property | Value | Notes |
+| -------- | ----- | ----- |
+| generator name | php-nextgen | pass this to the generate command after -g |
+| generator stability | BETA | |
+| generator type | CLIENT | |
+| generator language | PHP | |
+| generator default templating engine | mustache | |
+| helpTxt | Generates a PHP client library (beta). | |
+
+## CONFIG OPTIONS
+These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
+
+| Option | Description | Values | Default |
+| ------ | ----------- | ------ | ------- |
+|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
+|apiPackage|package for generated api classes| |null|
+|artifactVersion|The version to use in the composer package version field. e.g. 1.2.3| |null|
+|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
+|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
+|enumUnknownDefaultCase|If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.|<dl><dt>**false**</dt><dd>No changes to the enum's are made, this is the default option.</dd><dt>**true**</dt><dd>With this option enabled, each enum will have a new case, 'unknown_default_open_api', so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl>|false|
+|hideGenerationTimestamp|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |true|
+|invokerPackage|The main namespace to use for all classes. e.g. Yay\Pets| |null|
+|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt>**false**</dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl>|true|
+|modelPackage|package for generated models| |null|
+|packageName|The main package name for classes. e.g. GeneratedPetstore| |null|
+|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
+|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
+|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
+|srcBasePath|The directory to serve as source root.| |null|
+|variableNamingConvention|naming convention of variable name, e.g. camelCase.| |snake_case|
+
+## IMPORT MAPPING
+
+| Type/Alias | Imports |
+| ---------- | ------- |
+
+
+## INSTANTIATION TYPES
+
+| Type/Alias | Instantiated By |
+| ---------- | --------------- |
+|array|array|
+|map|array|
+
+
+## LANGUAGE PRIMITIVES
+
+<ul class="column-ul">
+<li>\DateTime</li>
+<li>\SplFileObject</li>
+<li>array</li>
+<li>bool</li>
+<li>boolean</li>
+<li>byte</li>
+<li>float</li>
+<li>int</li>
+<li>integer</li>
+<li>mixed</li>
+<li>number</li>
+<li>object</li>
+<li>string</li>
+<li>void</li>
+</ul>
+
+## RESERVED WORDS
+
+<ul class="column-ul">
+<li>__halt_compiler</li>
+<li>_header_accept</li>
+<li>_tempbody</li>
+<li>abstract</li>
+<li>and</li>
+<li>array</li>
+<li>as</li>
+<li>break</li>
+<li>callable</li>
+<li>case</li>
+<li>catch</li>
+<li>class</li>
+<li>clone</li>
+<li>const</li>
+<li>continue</li>
+<li>declare</li>
+<li>default</li>
+<li>die</li>
+<li>do</li>
+<li>echo</li>
+<li>else</li>
+<li>elseif</li>
+<li>empty</li>
+<li>enddeclare</li>
+<li>endfor</li>
+<li>endforeach</li>
+<li>endif</li>
+<li>endswitch</li>
+<li>endwhile</li>
+<li>eval</li>
+<li>exit</li>
+<li>extends</li>
+<li>final</li>
+<li>for</li>
+<li>foreach</li>
+<li>formparams</li>
+<li>function</li>
+<li>global</li>
+<li>goto</li>
+<li>headerparams</li>
+<li>httpbody</li>
+<li>if</li>
+<li>implements</li>
+<li>include</li>
+<li>include_once</li>
+<li>instanceof</li>
+<li>insteadof</li>
+<li>interface</li>
+<li>isset</li>
+<li>list</li>
+<li>namespace</li>
+<li>new</li>
+<li>or</li>
+<li>print</li>
+<li>private</li>
+<li>protected</li>
+<li>public</li>
+<li>queryparams</li>
+<li>require</li>
+<li>require_once</li>
+<li>resourcepath</li>
+<li>return</li>
+<li>static</li>
+<li>switch</li>
+<li>throw</li>
+<li>trait</li>
+<li>try</li>
+<li>unset</li>
+<li>use</li>
+<li>var</li>
+<li>while</li>
+<li>xor</li>
+</ul>
+
+## FEATURE SET
+
+
+### Client Modification Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasePath|✗|ToolingExtension
+|Authorizations|✗|ToolingExtension
+|UserAgent|✗|ToolingExtension
+|MockServer|✗|ToolingExtension
+
+### Data Type Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Custom|✗|OAS2,OAS3
+|Int32|✓|OAS2,OAS3
+|Int64|✓|OAS2,OAS3
+|Float|✓|OAS2,OAS3
+|Double|✓|OAS2,OAS3
+|Decimal|✓|ToolingExtension
+|String|✓|OAS2,OAS3
+|Byte|✓|OAS2,OAS3
+|Binary|✓|OAS2,OAS3
+|Boolean|✓|OAS2,OAS3
+|Date|✓|OAS2,OAS3
+|DateTime|✓|OAS2,OAS3
+|Password|✓|OAS2,OAS3
+|File|✓|OAS2
+|Uuid|✗|
+|Array|✓|OAS2,OAS3
+|Null|✗|OAS3
+|AnyType|✗|OAS2,OAS3
+|Object|✓|OAS2,OAS3
+|Maps|✓|ToolingExtension
+|CollectionFormat|✓|OAS2
+|CollectionFormatMulti|✓|OAS2
+|Enum|✓|OAS2,OAS3
+|ArrayOfEnum|✓|ToolingExtension
+|ArrayOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
+|ArrayOfCollectionOfModel|✓|ToolingExtension
+|ArrayOfCollectionOfEnum|✓|ToolingExtension
+|MapOfEnum|✓|ToolingExtension
+|MapOfModel|✓|ToolingExtension
+|MapOfCollectionOfPrimitives|✓|ToolingExtension
+|MapOfCollectionOfModel|✓|ToolingExtension
+|MapOfCollectionOfEnum|✓|ToolingExtension
+
+### Documentation Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Readme|✓|ToolingExtension
+|Model|✓|ToolingExtension
+|Api|✓|ToolingExtension
+
+### Global Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Host|✓|OAS2,OAS3
+|BasePath|✓|OAS2,OAS3
+|Info|✓|OAS2,OAS3
+|Schemes|✗|OAS2,OAS3
+|PartialSchemes|✓|OAS2,OAS3
+|Consumes|✓|OAS2
+|Produces|✓|OAS2
+|ExternalDocumentation|✓|OAS2,OAS3
+|Examples|✓|OAS2,OAS3
+|XMLStructureDefinitions|✗|OAS2,OAS3
+|MultiServer|✗|OAS3
+|ParameterizedServer|✗|OAS3
+|ParameterStyling|✗|OAS3
+|Callbacks|✗|OAS3
+|LinkObjects|✗|OAS3
+
+### Parameter Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Path|✓|OAS2,OAS3
+|Query|✓|OAS2,OAS3
+|Header|✓|OAS2,OAS3
+|Body|✓|OAS2
+|FormUnencoded|✓|OAS2
+|FormMultipart|✓|OAS2
+|Cookie|✓|OAS3
+
+### Schema Support Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|Simple|✓|OAS2,OAS3
+|Composite|✓|OAS2,OAS3
+|Polymorphism|✗|OAS2,OAS3
+|Union|✗|OAS3
+|allOf|✗|OAS2,OAS3
+|anyOf|✗|OAS3
+|oneOf|✗|OAS3
+|not|✗|OAS3
+
+### Security Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|BasicAuth|✗|OAS2,OAS3
+|ApiKey|✗|OAS2,OAS3
+|OpenIDConnect|✗|OAS3
+|BearerToken|✗|OAS3
+|OAuth2_Implicit|✗|OAS2,OAS3
+|OAuth2_Password|✗|OAS2,OAS3
+|OAuth2_ClientCredentials|✗|OAS2,OAS3
+|OAuth2_AuthorizationCode|✗|OAS2,OAS3
+
+### Wire Format Feature
+| Name | Supported | Defined By |
+| ---- | --------- | ---------- |
+|JSON|✓|OAS2,OAS3
+|XML|✓|OAS2,OAS3
+|PROTOBUF|✗|ToolingExtension
+|Custom|✗|OAS2,OAS3
--- 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
@@ -22,6 +22,8 @@ import org.openapitools.codegen.CliOption;
 import org.openapitools.codegen.CodegenConstants;
 import org.openapitools.codegen.CodegenType;
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.meta.GeneratorMetadata;
+import org.openapitools.codegen.meta.Stability;
 import org.openapitools.codegen.meta.features.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -39,6 +41,10 @@ public class PhpNextgenClientCodegen extends AbstractPhpCodegen {
    public PhpNextgenClientCodegen() {
        super();

+        // mark as beta so far
+        this.generatorMetadata = GeneratorMetadata.newBuilder(generatorMetadata)
+                .stability(Stability.BETA).build();
+
        modifyFeatureSet(features -> features
                .includeDocumentationFeatures(DocumentationFeature.Readme)
                .wireFormatFeatures(EnumSet.of(WireFormatFeature.JSON, WireFormatFeature.XML))

--- a/modules/openapi-generator/src/main/resources/php-nextgen/.travis.yml
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/.travis.yml
 language: php
-# Bionic environment has preinstalled PHP from 7.1 to 7.4
-# https://docs.travis-ci.com/user/reference/bionic/#php-support
-dist: bionic
+# Jammy Jellyfish environment has preinstalled PHP 8.1
+# Focal Fossa doesn't fit since it contains preinstalled PHP 7.4 only
+# https://docs.travis-ci.com/user/reference/jammy/#php-support
+dist: jammy
+os:
+  - linux
 php:
-    - 7.4
+  - 8.0
+  - 8.1
 before_install: "composer install"
 script: "vendor/bin/phpunit"
--- a/modules/openapi-generator/src/main/resources/php-nextgen/ApiException.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/ApiException.mustache
 <?php
 /**
 * ApiException
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/Configuration.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/Configuration.mustache
 <?php
 /**
 * Configuration
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}
@@ -20,7 +20,6 @@ namespace {{invokerPackage}};

 /**
 * Configuration Class Doc Comment
- * PHP version 7.4
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/HeaderSelector.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/HeaderSelector.mustache
 <?php
 /**
 * HeaderSelector
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/ModelInterface.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/ModelInterface.mustache
@@ -2,7 +2,7 @@
 /**
 * ModelInterface
 *
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{modelPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/ObjectSerializer.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/ObjectSerializer.mustache
@@ -2,7 +2,7 @@
 /**
 * ObjectSerializer
 *
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/README.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/README.mustache
@@ -12,8 +12,7 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}).

 ### Requirements

-PHP 7.4 and later.
-Should also work with PHP 8.0.
+PHP 8.0 and later.

 ### Composer


--- a/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
 <?php
 /**
 * {{classname}}
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/api_test.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/api_test.mustache
 <?php
 /**
 * {{classname}}Test
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/composer.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/composer.mustache
@@ -24,15 +24,15 @@
        }
    ],
    "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.0",
        "ext-curl": "*",
        "ext-json": "*",
        "ext-mbstring": "*",
-        "guzzlehttp/guzzle": "^7.3",
-        "guzzlehttp/psr7": "^1.7 || ^2.0"
+        "guzzlehttp/guzzle": "^7.4.5",
+        "guzzlehttp/psr7": "^2.0"
    },
    "require-dev": {
-        "phpunit/phpunit": "^8.0 || ^9.0",
+        "phpunit/phpunit": "^9.0",
        "friendsofphp/php-cs-fixer": "^3.5"
    },
    "autoload": {

--- a/modules/openapi-generator/src/main/resources/php-nextgen/model.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/model.mustache
@@ -4,7 +4,7 @@
 /**
 * {{classname}}
 *
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/modules/openapi-generator/src/main/resources/php-nextgen/model_test.mustache
+++ b/modules/openapi-generator/src/main/resources/php-nextgen/model_test.mustache
@@ -4,7 +4,7 @@
 /**
 * {{classname}}Test
 *
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  {{invokerPackage}}

--- a/samples/client/petstore/php-nextgen/OpenAPIClient-php/.travis.yml
+++ b/samples/client/petstore/php-nextgen/OpenAPIClient-php/.travis.yml
 language: php
-# Bionic environment has preinstalled PHP from 7.1 to 7.4
-# https://docs.travis-ci.com/user/reference/bionic/#php-support
-dist: bionic
+# Jammy Jellyfish environment has preinstalled PHP 8.1
+# Focal Fossa doesn't fit since it contains preinstalled PHP 7.4 only
+# https://docs.travis-ci.com/user/reference/jammy/#php-support
+dist: jammy
+os:
+  - linux
 php:
-    - 7.4
+  - 8.0
+  - 8.1
 before_install: "composer install"
 script: "vendor/bin/phpunit"
--- a/samples/client/petstore/php-nextgen/OpenAPIClient-php/README.md
+++ b/samples/client/petstore/php-nextgen/OpenAPIClient-php/README.md
@@ -7,8 +7,7 @@ This spec is mainly for testing Petstore server and contains fake endpoints, mod

 ### Requirements

-PHP 7.4 and later.
-Should also work with PHP 8.0.
+PHP 8.0 and later.

 ### Composer

@@ -223,4 +222,4 @@ vendor/bin/phpunit
 This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

 - API version: `1.0.0`
- Build package: `org.openapitools.codegen.languages.PhpClientCodegen`
+- Build package: `org.openapitools.codegen.languages.PhpNextgenClientCodegen`
--- a/samples/client/petstore/php-nextgen/OpenAPIClient-php/composer.json
+++ b/samples/client/petstore/php-nextgen/OpenAPIClient-php/composer.json
@@ -18,15 +18,15 @@
        }
    ],
    "require": {
-        "php": "^7.4 || ^8.0",
+        "php": "^8.0",
        "ext-curl": "*",
        "ext-json": "*",
        "ext-mbstring": "*",
-        "guzzlehttp/guzzle": "^7.3",
-        "guzzlehttp/psr7": "^1.7 || ^2.0"
+        "guzzlehttp/guzzle": "^7.4.5",
+        "guzzlehttp/psr7": "^2.0"
    },
    "require-dev": {
-        "phpunit/phpunit": "^8.0 || ^9.0",
+        "phpunit/phpunit": "^9.0",
        "friendsofphp/php-cs-fixer": "^3.5"
    },
    "autoload": {

--- a/samples/client/petstore/php-nextgen/OpenAPIClient-php/lib/Api/AnotherFakeApi.php
+++ b/samples/client/petstore/php-nextgen/OpenAPIClient-php/lib/Api/AnotherFakeApi.php
 <?php
 /**
 * AnotherFakeApi
- * PHP version 7.4
+ * PHP version 8.0
 *
 * @category Class
 * @package  OpenAPI\Client