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

This commit is contained in:
Julian Vennen 2024-07-23 04:00:48 +02:00 committed by GitHub
parent 08e2653935
commit 3e263ce3fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 27 additions and 27 deletions

View File

@ -39,7 +39,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected ?array $responseHeaders; protected ?array $responseHeaders;
@ -55,10 +55,10 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @param int $code HTTP status code
* @param string[]|null $responseHeaders HTTP response header * @param string[][]|null $responseHeaders HTTP response header
* @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string * @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); parent::__construct($message, $code);
$this->responseHeaders = $responseHeaders; $this->responseHeaders = $responseHeaders;
@ -68,7 +68,7 @@ class ApiException extends Exception
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders(): ?array public function getResponseHeaders(): ?array
{ {

View File

@ -40,7 +40,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected $responseHeaders; protected $responseHeaders;
@ -56,7 +56,7 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @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 * @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) public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
@ -69,7 +69,7 @@ class ApiException extends Exception
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders() public function getResponseHeaders()
{ {

View File

@ -44,7 +44,7 @@ class ApiException extends RequestException
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected $responseHeaders; protected $responseHeaders;
@ -72,7 +72,7 @@ class ApiException extends RequestException
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders() public function getResponseHeaders()
{ {

View File

@ -49,7 +49,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected ?array $responseHeaders; protected ?array $responseHeaders;
@ -65,10 +65,10 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @param int $code HTTP status code
* @param string[]|null $responseHeaders HTTP response header * @param string[][]|null $responseHeaders HTTP response header
* @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string * @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); parent::__construct($message, $code);
$this->responseHeaders = $responseHeaders; $this->responseHeaders = $responseHeaders;
@ -78,7 +78,7 @@ class ApiException extends Exception
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders(): ?array public function getResponseHeaders(): ?array
{ {

View File

@ -49,7 +49,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected $responseHeaders; protected $responseHeaders;
@ -65,7 +65,7 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @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 * @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) public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)

View File

@ -48,7 +48,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected ?array $responseHeaders; protected ?array $responseHeaders;
@ -64,10 +64,10 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @param int $code HTTP status code
* @param string[]|null $responseHeaders HTTP response header * @param string[][]|null $responseHeaders HTTP response header
* @param mixed $responseBody HTTP decoded body of the server response either as stdClass or string * @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); parent::__construct($message, $code);
$this->responseHeaders = $responseHeaders; $this->responseHeaders = $responseHeaders;
@ -77,7 +77,7 @@ class ApiException extends Exception
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders(): ?array public function getResponseHeaders(): ?array
{ {

View File

@ -49,7 +49,7 @@ class ApiException extends Exception
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected $responseHeaders; protected $responseHeaders;
@ -65,7 +65,7 @@ class ApiException extends Exception
* *
* @param string $message Error message * @param string $message Error message
* @param int $code HTTP status code * @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 * @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) public function __construct($message = "", $code = 0, $responseHeaders = [], $responseBody = null)
@ -78,7 +78,7 @@ class ApiException extends Exception
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders() public function getResponseHeaders()
{ {

View File

@ -53,7 +53,7 @@ class ApiException extends RequestException
/** /**
* The HTTP header of the server response. * The HTTP header of the server response.
* *
* @var string[]|null * @var string[][]|null
*/ */
protected $responseHeaders; protected $responseHeaders;
@ -81,7 +81,7 @@ class ApiException extends RequestException
/** /**
* Gets the HTTP response header * Gets the HTTP response header
* *
* @return string[]|null HTTP response header * @return string[][]|null HTTP response header
*/ */
public function getResponseHeaders() public function getResponseHeaders()
{ {