php: Fix typedoc comment for headers in ApiException (#19217)

JulianVennen · web-flow · commit 3e263ce3fc5c · 2024-07-23T10:00:48.000+08:00
diff --git a/modules/openapi-generator/src/main/resources/php-nextgen/ApiException.mustache b/modules/openapi-generator/src/main/resources/php-nextgen/ApiException.mustache
@@ -39,7 +39,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected ?array $responseHeaders;
 
@@ -55,10 +55,10 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
-     * @param mixed $responseBody    HTTP decoded body of the server response either as stdClass or string
+     * @param string[][]|null       $responseHeaders HTTP response header
+     * @param stdClass|string|null  $responseBody    HTTP decoded body of the server response either as stdClass or string
      */
-    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)
+    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass|string|null $responseBody = null)
     {
         parent::__construct($message, $code);
         $this->responseHeaders = $responseHeaders;
@@ -68,7 +68,7 @@ class ApiException extends Exception
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders(): ?array
     {
diff --git a/modules/openapi-generator/src/main/resources/php/ApiException.mustache b/modules/openapi-generator/src/main/resources/php/ApiException.mustache
@@ -40,7 +40,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected $responseHeaders;
 
@@ -56,7 +56,7 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
+     * @param string[][]|null       $responseHeaders HTTP response header
      * @param \stdClass|string|null $responseBody    HTTP decoded body of the server response either as \stdClass or string
      */
     public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
@@ -69,7 +69,7 @@ class ApiException extends Exception
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders()
     {
diff --git a/modules/openapi-generator/src/main/resources/php/libraries/psr-18/ApiException.mustache b/modules/openapi-generator/src/main/resources/php/libraries/psr-18/ApiException.mustache
@@ -44,7 +44,7 @@ class ApiException extends RequestException
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected $responseHeaders;
 
@@ -72,7 +72,7 @@ class ApiException extends RequestException
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders()
     {
diff --git a/samples/client/echo_api/php-nextgen/src/ApiException.php b/samples/client/echo_api/php-nextgen/src/ApiException.php
@@ -49,7 +49,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected ?array $responseHeaders;
 
@@ -65,10 +65,10 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
-     * @param mixed $responseBody    HTTP decoded body of the server response either as stdClass or string
+     * @param string[][]|null       $responseHeaders HTTP response header
+     * @param stdClass|string|null  $responseBody    HTTP decoded body of the server response either as stdClass or string
      */
-    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)
+    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass|string|null $responseBody = null)
     {
         parent::__construct($message, $code);
         $this->responseHeaders = $responseHeaders;
@@ -78,7 +78,7 @@ public function __construct(string $message = "", int $code = 0, ?array $respons
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders(): ?array
     {
diff --git a/samples/client/petstore/php-nextgen/OpenAPIClient-php/lib/ApiException.php b/samples/client/petstore/php-nextgen/OpenAPIClient-php/lib/ApiException.php
@@ -49,7 +49,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected $responseHeaders;
 
@@ -65,7 +65,7 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
+     * @param string[][]|null       $responseHeaders HTTP response headerr
      * @param \stdClass|string|null $responseBody    HTTP decoded body of the server response either as \stdClass or string
      */
     public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
diff --git a/samples/client/petstore/php-nextgen/OpenAPIClient-php/src/ApiException.php b/samples/client/petstore/php-nextgen/OpenAPIClient-php/src/ApiException.php
@@ -48,7 +48,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected ?array $responseHeaders;
 
@@ -64,10 +64,10 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
-     * @param mixed $responseBody    HTTP decoded body of the server response either as stdClass or string
+     * @param string[][]|null       $responseHeaders HTTP response header
+     * @param stdClass|string|null  $responseBody    HTTP decoded body of the server response either as stdClass or string
      */
-    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)
+    public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass|string|null $responseBody = null)
     {
         parent::__construct($message, $code);
         $this->responseHeaders = $responseHeaders;
@@ -77,7 +77,7 @@ public function __construct(string $message = "", int $code = 0, ?array $respons
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders(): ?array
     {
diff --git a/samples/client/petstore/php/OpenAPIClient-php/lib/ApiException.php b/samples/client/petstore/php/OpenAPIClient-php/lib/ApiException.php
@@ -49,7 +49,7 @@ class ApiException extends Exception
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected $responseHeaders;
 
@@ -65,7 +65,7 @@ class ApiException extends Exception
      *
      * @param string                $message         Error message
      * @param int                   $code            HTTP status code
-     * @param string[]|null         $responseHeaders HTTP response header
+     * @param string[][]|null       $responseHeaders HTTP response header
      * @param \stdClass|string|null $responseBody    HTTP decoded body of the server response either as \stdClass or string
      */
     public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
@@ -78,7 +78,7 @@ public function __construct($message = "", $code = 0, $responseHeaders = [], $re
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders()
     {
diff --git a/samples/client/petstore/php/psr-18/lib/ApiException.php b/samples/client/petstore/php/psr-18/lib/ApiException.php
@@ -53,7 +53,7 @@ class ApiException extends RequestException
     /**
      * The HTTP header of the server response.
      *
-     * @var string[]|null
+     * @var string[][]|null
      */
     protected $responseHeaders;
 
@@ -81,7 +81,7 @@ public function __construct(
     /**
      * Gets the HTTP response header
      *
-     * @return string[]|null HTTP response header
+     * @return string[][]|null HTTP response header
      */
     public function getResponseHeaders()
     {

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ class ApiException extends Exception`
`39`	`39`	`/**`
`40`	`40`	`* The HTTP header of the server response.`
`41`	`41`	`*`
`42`		`- * @var string[]\|null`
	`42`	`+ * @var string[][]\|null`
`43`	`43`	`*/`
`44`	`44`	`protected ?array $responseHeaders;`
`45`	`45`
`@@ -55,10 +55,10 @@ class ApiException extends Exception`
`55`	`55`	`*`
`56`	`56`	`* @param string $message Error message`
`57`	`57`	`* @param int $code HTTP status code`
`58`		`- * @param string[]\|null $responseHeaders HTTP response header`
`59`		`- * @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string`
	`58`	`+ * @param string[][]\|null $responseHeaders HTTP response header`
	`59`	`+ * @param stdClass\|string\|null $responseBody HTTP decoded body of the server response either as stdClass or string`
`60`	`60`	`*/`
`61`		`- public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)`
	`61`	`+ public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass\|string\|null $responseBody = null)`
`62`	`62`	`{`
`63`	`63`	`parent::__construct($message, $code);`
`64`	`64`	`$this->responseHeaders = $responseHeaders;`
`@@ -68,7 +68,7 @@ class ApiException extends Exception`
`68`	`68`	`/**`
`69`	`69`	`* Gets the HTTP response header`
`70`	`70`	`*`
`71`		`- * @return string[]\|null HTTP response header`
	`71`	`+ * @return string[][]\|null HTTP response header`
`72`	`72`	`*/`
`73`	`73`	`public function getResponseHeaders(): ?array`
`74`	`74`	`{`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ class ApiException extends Exception`
`40`	`40`	`/**`
`41`	`41`	`* The HTTP header of the server response.`
`42`	`42`	`*`
`43`		`- * @var string[]\|null`
	`43`	`+ * @var string[][]\|null`
`44`	`44`	`*/`
`45`	`45`	`protected $responseHeaders;`
`46`	`46`
`@@ -56,7 +56,7 @@ class ApiException extends Exception`
`56`	`56`	`*`
`57`	`57`	`* @param string $message Error message`
`58`	`58`	`* @param int $code HTTP status code`
`59`		`- * @param string[]\|null $responseHeaders HTTP response header`
	`59`	`+ * @param string[][]\|null $responseHeaders HTTP response header`
`60`	`60`	`* @param \stdClass\|string\|null $responseBody HTTP decoded body of the server response either as \stdClass or string`
`61`	`61`	`*/`
`62`	`62`	`public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)`
`@@ -69,7 +69,7 @@ class ApiException extends Exception`
`69`	`69`	`/**`
`70`	`70`	`* Gets the HTTP response header`
`71`	`71`	`*`
`72`		`- * @return string[]\|null HTTP response header`
	`72`	`+ * @return string[][]\|null HTTP response header`
`73`	`73`	`*/`
`74`	`74`	`public function getResponseHeaders()`
`75`	`75`	`{`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class ApiException extends RequestException`
`44`	`44`	`/**`
`45`	`45`	`* The HTTP header of the server response.`
`46`	`46`	`*`
`47`		`- * @var string[]\|null`
	`47`	`+ * @var string[][]\|null`
`48`	`48`	`*/`
`49`	`49`	`protected $responseHeaders;`
`50`	`50`
`@@ -72,7 +72,7 @@ class ApiException extends RequestException`
`72`	`72`	`/**`
`73`	`73`	`* Gets the HTTP response header`
`74`	`74`	`*`
`75`		`- * @return string[]\|null HTTP response header`
	`75`	`+ * @return string[][]\|null HTTP response header`
`76`	`76`	`*/`
`77`	`77`	`public function getResponseHeaders()`
`78`	`78`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class ApiException extends Exception`
`49`	`49`	`/**`
`50`	`50`	`* The HTTP header of the server response.`
`51`	`51`	`*`
`52`		`- * @var string[]\|null`
	`52`	`+ * @var string[][]\|null`
`53`	`53`	`*/`
`54`	`54`	`protected ?array $responseHeaders;`
`55`	`55`
`@@ -65,10 +65,10 @@ class ApiException extends Exception`
`65`	`65`	`*`
`66`	`66`	`* @param string $message Error message`
`67`	`67`	`* @param int $code HTTP status code`
`68`		`- * @param string[]\|null $responseHeaders HTTP response header`
`69`		`- * @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string`
	`68`	`+ * @param string[][]\|null $responseHeaders HTTP response header`
	`69`	`+ * @param stdClass\|string\|null $responseBody HTTP decoded body of the server response either as stdClass or string`
`70`	`70`	`*/`
`71`		`- public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)`
	`71`	`+ public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass\|string\|null $responseBody = null)`
`72`	`72`	`{`
`73`	`73`	`parent::__construct($message, $code);`
`74`	`74`	`$this->responseHeaders = $responseHeaders;`
`@@ -78,7 +78,7 @@ public function __construct(string $message = "", int $code = 0, ?array $respons`
`78`	`78`	`/**`
`79`	`79`	`* Gets the HTTP response header`
`80`	`80`	`*`
`81`		`- * @return string[]\|null HTTP response header`
	`81`	`+ * @return string[][]\|null HTTP response header`
`82`	`82`	`*/`
`83`	`83`	`public function getResponseHeaders(): ?array`
`84`	`84`	`{`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ class ApiException extends Exception`
`48`	`48`	`/**`
`49`	`49`	`* The HTTP header of the server response.`
`50`	`50`	`*`
`51`		`- * @var string[]\|null`
	`51`	`+ * @var string[][]\|null`
`52`	`52`	`*/`
`53`	`53`	`protected ?array $responseHeaders;`
`54`	`54`
`@@ -64,10 +64,10 @@ class ApiException extends Exception`
`64`	`64`	`*`
`65`	`65`	`* @param string $message Error message`
`66`	`66`	`* @param int $code HTTP status code`
`67`		`- * @param string[]\|null $responseHeaders HTTP response header`
`68`		`- * @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string`
	`67`	`+ * @param string[][]\|null $responseHeaders HTTP response header`
	`68`	`+ * @param stdClass\|string\|null $responseBody HTTP decoded body of the server response either as stdClass or string`
`69`	`69`	`*/`
`70`		`- public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], mixed $responseBody = null)`
	`70`	`+ public function __construct(string $message = "", int $code = 0, ?array $responseHeaders = [], stdClass\|string\|null $responseBody = null)`
`71`	`71`	`{`
`72`	`72`	`parent::__construct($message, $code);`
`73`	`73`	`$this->responseHeaders = $responseHeaders;`
`@@ -77,7 +77,7 @@ public function __construct(string $message = "", int $code = 0, ?array $respons`
`77`	`77`	`/**`
`78`	`78`	`* Gets the HTTP response header`
`79`	`79`	`*`
`80`		`- * @return string[]\|null HTTP response header`
	`80`	`+ * @return string[][]\|null HTTP response header`
`81`	`81`	`*/`
`82`	`82`	`public function getResponseHeaders(): ?array`
`83`	`83`	`{`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ class ApiException extends RequestException`
`53`	`53`	`/**`
`54`	`54`	`* The HTTP header of the server response.`
`55`	`55`	`*`
`56`		`- * @var string[]\|null`
	`56`	`+ * @var string[][]\|null`
`57`	`57`	`*/`
`58`	`58`	`protected $responseHeaders;`
`59`	`59`
`@@ -81,7 +81,7 @@ public function __construct(`
`81`	`81`	`/**`
`82`	`82`	`* Gets the HTTP response header`
`83`	`83`	`*`
`84`		`- * @return string[]\|null HTTP response header`
	`84`	`+ * @return string[][]\|null HTTP response header`
`85`	`85`	`*/`
`86`	`86`	`public function getResponseHeaders()`
`87`	`87`	`{`