[PHP] 6.0.x make php implementation depend on meta packages for http client (#16368)

* add psr-18 support

* update doc

* fix test

Author: wing328

bin/configs/php-psr-18.yaml

@@ -0,0 +1,12 @@
+generatorName: php
+outputDir: samples/client/petstore/php/psr-18
+inputSpec: modules/openapi-generator/src/test/resources/3_0/php/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/php
+library: psr-18
+nameMappings:
+  _type: underscore_type
+  type_: type_with_underscore
+  type-: type_with_dash
+parameterNameMappings:
+  _type: underscore_type
+  type_: type_with_underscore

docs/generators/php.md

@@ -31,6 +31,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |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|
+|library|HTTP library template (sub-template) to use|<dl><dt>**guzzle**</dt><dd>Guzzle</dd><dt>**psr-18**</dt><dd>psr/http-client-implementation, also known as PSR-18. (beta support)</dd></dl>|guzzle|
 |licenseName|The name of the license| |null|
 |modelPackage|package for generated models| |null|
 |packageName|The main package name for classes. e.g. GeneratedPetstore| |null|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/PhpClientCodegen.java

@@ -35,6 +35,8 @@
 public class PhpClientCodegen extends AbstractPhpCodegen {
     @SuppressWarnings("hiding")
     private final Logger LOGGER = LoggerFactory.getLogger(PhpClientCodegen.class);
+    public static final String GUZZLE = "guzzle";
+    public static final String PSR18 = "psr-18";
 
     public PhpClientCodegen() {
         super();
@@ -82,6 +84,15 @@ public PhpClientCodegen() {
 
         cliOptions.add(new CliOption(CodegenConstants.HIDE_GENERATION_TIMESTAMP, CodegenConstants.ALLOW_UNICODE_IDENTIFIERS_DESC)
                 .defaultValue(Boolean.TRUE.toString()));
+
+        supportedLibraries.put(GUZZLE, "Guzzle");
+        supportedLibraries.put(PSR18, "psr/http-client-implementation, also known as PSR-18. (beta support)");
+        CliOption libraryOption = new CliOption(CodegenConstants.LIBRARY, "HTTP library template (sub-template) to use");
+        libraryOption.setEnum(supportedLibraries);
+        // set GUZZLE as the default
+        libraryOption.setDefault(GUZZLE);
+        cliOptions.add(libraryOption);
+        setLibrary(GUZZLE);
     }
 
     @Override
@@ -114,5 +125,14 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile(".travis.yml", "", ".travis.yml"));
         supportingFiles.add(new SupportingFile(".php-cs-fixer.dist.php", "", ".php-cs-fixer.dist.php"));
         supportingFiles.add(new SupportingFile("git_push.sh.mustache", "", "git_push.sh"));
+
+        if (additionalProperties.containsKey(CodegenConstants.LIBRARY)) {
+            this.setLibrary((String) additionalProperties.get(CodegenConstants.LIBRARY));
+        }
+
+        if (PSR18.equals(getLibrary())) {
+            supportingFiles.add(new SupportingFile("DebugPlugin.mustache", toSrcPath(invokerPackage, srcBasePath), "DebugPlugin.php"));
+        }
+
     }
 }

modules/openapi-generator/src/main/resources/php/libraries/psr-18/ApiException.mustache

@@ -0,0 +1,113 @@
+<?php
+/**
+ * ApiException
+ * PHP version 7.2
+ *
+ * @category Class
+ * @package  {{invokerPackage}}
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+
+{{>partial_header}}
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+namespace {{invokerPackage}};
+
+use Exception;
+use Http\Client\Exception\RequestException;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * ApiException Class Doc Comment
+ *
+ * @category Class
+ * @package  {{invokerPackage}}
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+class ApiException extends RequestException
+{
+
+    /**
+     * The HTTP body of the server response either as Json or string.
+     *
+     * @var string|null
+     */
+    protected $responseBody;
+
+    /**
+     * The HTTP header of the server response.
+     *
+     * @var string[]|null
+     */
+    protected $responseHeaders;
+
+    /**
+     * The deserialized response object
+     *
+     * @var \stdClass|string|null
+     */
+    protected $responseObject;
+
+    public function __construct(
+        $message,
+        RequestInterface $request,
+        ResponseInterface $response = null,
+        Exception $previous = null
+    ) {
+        parent::__construct($message, $request, $previous);
+        if ($response) {
+            $this->responseHeaders = $response->getHeaders();
+            $this->responseBody = (string) $response->getBody();
+            $this->code = $response->getStatusCode();
+        }
+    }
+
+    /**
+     * Gets the HTTP response header
+     *
+     * @return string[]|null HTTP response header
+     */
+    public function getResponseHeaders()
+    {
+        return $this->responseHeaders;
+    }
+
+    /**
+     * Gets the HTTP body of the server response either as Json or string
+     *
+     * @return \stdClass|string|null HTTP body of the server response either as \stdClass or string
+     */
+    public function getResponseBody()
+    {
+        return $this->responseBody;
+    }
+
+    /**
+     * Sets the deseralized response object (during deserialization)
+     *
+     * @param mixed $obj Deserialized response object
+     *
+     * @return void
+     */
+    public function setResponseObject($obj)
+    {
+        $this->responseObject = $obj;
+    }
+
+    /**
+     * Gets the deseralized response object (during deserialization)
+     *
+     * @return mixed the deserialized response object
+     */
+    public function getResponseObject()
+    {
+        return $this->responseObject;
+    }
+}

modules/openapi-generator/src/main/resources/php/libraries/psr-18/DebugPlugin.mustache

@@ -0,0 +1,92 @@
+<?php
+/**
+ * Configuration
+ * PHP version 7.2
+ *
+ * @category Class
+ * @package  {{invokerPackage}}
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+
+{{>partial_header}}
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+namespace {{invokerPackage}};
+
+use Http\Client\Common\Plugin;
+use Http\Promise\Promise;
+use Psr\Http\Client\ClientExceptionInterface;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use function is_resource;
+
+/**
+ * Configuration Class Doc Comment
+ * PHP version 7.2
+ *
+ * @category Class
+ * @package  {{invokerPackage}}
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+class DebugPlugin implements Plugin
+{
+
+    /**
+     * @var resource
+     */
+    private $output;
+
+    /**
+     * DebuggingPlugin constructor.
+     *
+     * @param resource $output
+     */
+    public function __construct($output)
+    {
+        if (!is_resource($output)) {
+            throw new \InvalidArgumentException('debugging resource is not valid');
+        }
+        $this->output = $output;
+    }
+
+    public function handleRequest(RequestInterface $request, callable $next, callable $first): Promise
+    {
+        return $next($request)->then(
+            function (ResponseInterface $response) use ($request) {
+                $this->logSuccess($request, $response);
+
+                return $response;
+            },
+            function (ClientExceptionInterface $exception) use ($request) {
+                $this->logError($request, $exception);
+
+                throw $exception;
+            }
+        );
+    }
+
+    private function logSuccess(RequestInterface $request, ResponseInterface $response): void
+    {
+        $methodAndPath = $request->getMethod() . ' ' . $request->getUri()->getPath();
+        $protocol = $response->getProtocolVersion();
+        $responseCode = $response->getStatusCode();
+        \fprintf($this->output, '<%s HTTP/%s> %s', $methodAndPath, $protocol, $responseCode);
+        \fwrite($this->output, "\n");
+    }
+
+    private function logError(RequestInterface $request, ClientExceptionInterface $exception): void
+    {
+        $methodAndPath = $request->getMethod() . ' ' . $request->getUri()->getPath();
+        $protocol = $request->getProtocolVersion();
+        $error = $exception->getMessage();
+        $responseCode = $exception->getCode();
+        \fprintf($this->output, '<%s HTTP/%s> %s %s', $methodAndPath, $responseCode, $error, $protocol);
+        \fwrite($this->output, "\n");
+    }
+}