Merge pull request php-vcr#393 from php-vcr/392-apply-changed-codestyle-review-found-phpstan-recommendationsissues

392 apply changed codestyle review found phpstan recommendationsissues

Author: higidi

phpstan-baseline.neon

@@ -5,6 +5,11 @@ parameters:
 count: 1
 path: src/VCR/Util/HttpUtil.php
 
+-
+message: "#^Method VCR\\\\Util\\\\HttpUtil\\:\\:parseHeaders\\(\\) should return array\\<string, string\\> but returns array\\<array\\<int, string\\>\\|string\\>\\.$#"
+count: 1
+path: src/VCR/Util/HttpUtil.php
+
 -
 message: "#^Parameter \\#1 \\$string of function substr expects string, string\\|false given\\.$#"
 count: 1

src/VCR/CodeTransform/CurlCodeTransform.php

@@ -29,9 +29,6 @@ class CurlCodeTransform extends AbstractCodeTransform
  '/(?<!::|->|\w_)\\\?curl_errno\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_errno(',
  ];
 
- /**
- * {@inheritdoc}
- */
  protected function transformCode(string $code): string
  {
  $transformedCode = preg_replace(array_keys(self::$patterns), array_values(self::$patterns), $code);

src/VCR/CodeTransform/SoapCodeTransform.php

@@ -26,9 +26,6 @@ class SoapCodeTransform extends AbstractCodeTransform
  '@extends\s+\\\?SoapClient\b@i',
  ];
 
- /**
- * {@inheritdoc}
- */
  protected function transformCode(string $code): string
  {
  $transformedCode = preg_replace(self::$patterns, self::$replacements, $code);

src/VCR/LibraryHooks/CurlHook.php

@@ -60,9 +60,6 @@ public function __construct(
  ) {
  }
 
- /**
- * {@inheritdoc}
- */
  public function enable(\Closure $requestCallback): void
  {
  if (self::ENABLED == static::$status) {
@@ -78,19 +75,13 @@ public function enable(\Closure $requestCallback): void
  static::$status = self::ENABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function disable(): void
  {
  self::$requestCallback = null;
 
  static::$status = self::DISABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function isEnabled(): bool
  {
  return self::ENABLED == self::$status;
@@ -135,7 +126,7 @@ public static function __callStatic($method, array $args)
  /**
  * @see http://www.php.net/manual/en/function.curl-init.php
  */
- public static function curlInit(?string $url = null): \CurlHandle|false
+ public static function curlInit(string $url = null): \CurlHandle|false
  {
  $curlHandle = curl_init($url);
  if (false !== $curlHandle) {
@@ -271,10 +262,8 @@ public static function curlMultiGetcontent(\CurlHandle $curlHandle): ?string
  * Get information regarding a specific transfer.
  *
  * @see http://www.php.net/manual/en/function.curl-getinfo.php
- *
- * @return mixed
  */
- public static function curlGetinfo(\CurlHandle $curlHandle, int $option = 0)
+ public static function curlGetinfo(\CurlHandle $curlHandle, int $option = 0): mixed
  {
  if (isset(self::$responses[(int) $curlHandle])) {
  return CurlHelper::getCurlOptionFromResponse(

src/VCR/LibraryHooks/SoapHook.php

@@ -67,9 +67,6 @@ public function doRequest(string $request, string $location, string $action, int
  return $response->getBody();
  }
 
- /**
- * {@inheritdoc}
- */
  public function enable(\Closure $requestCallback): void
  {
  self::$requestCallback = $requestCallback;
@@ -85,19 +82,13 @@ public function enable(\Closure $requestCallback): void
  $this->status = self::ENABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function disable(): void
  {
  self::$requestCallback = null;
 
  $this->status = self::DISABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function isEnabled(): bool
  {
  return self::ENABLED == $this->status;

src/VCR/LibraryHooks/StreamWrapperHook.php

@@ -17,19 +17,13 @@ class StreamWrapperHook implements LibraryHook
 
  protected string $status = self::DISABLED;
 
- /**
- * @var Response
- */
- protected $response;
+ protected Response $response;
 
  /**
  * @var resource current stream context
  */
  public $context;
 
- /**
- * {@inheritdoc}
- */
  public function enable(\Closure $requestCallback): void
  {
  self::$requestCallback = $requestCallback;
@@ -42,9 +36,6 @@ public function enable(\Closure $requestCallback): void
  $this->status = self::ENABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function disable(): void
  {
  self::$requestCallback = null;
@@ -54,9 +45,6 @@ public function disable(): void
  $this->status = self::DISABLED;
  }
 
- /**
- * {@inheritdoc}
- */
  public function isEnabled(): bool
  {
  return self::ENABLED == $this->status;

src/VCR/Request.php

@@ -217,10 +217,7 @@ public function getCurlOptions(): array
  return $this->curlOptions;
  }
 
- /**
- * @return mixed
- */
- public function getCurlOption(int $key)
+ public function getCurlOption(int $key): mixed
  {
  if (empty($this->curlOptions[$key])) {
  return null;
@@ -278,18 +275,12 @@ public function removeHeader(string $key): void
  unset($this->headers[$key]);
  }
 
- /**
- * @param mixed $value
- */
- public function setPostField(string $key, $value): void
+ public function setPostField(string $key, mixed $value): void
  {
  $this->postFields[$key] = $value;
  }
 
- /**
- * @param mixed $value
- */
- public function setCurlOption(int $key, $value): void
+ public function setCurlOption(int $key, mixed $value): void
  {
  $this->curlOptions[$key] = $value;
  }

src/VCR/Response.php

@@ -18,27 +18,21 @@ class Response
  /**
  * @var array<string,string>
  */
- protected $headers = [];
- /**
- * @var string|null
- */
- protected $body;
+ protected array $headers = [];
+ protected ?string $body;
  /**
  * @var array<string,mixed>
  */
- protected $curlInfo = [];
+ protected array $curlInfo = [];
 
- /**
- * @var mixed
- */
- protected $httpVersion;
+ protected mixed $httpVersion;
 
  /**
  * @param string|array<string, string> $status
  * @param array<string,string> $headers
  * @param array<string,mixed> $curlInfo
  */
- final public function __construct($status, array $headers = [], ?string $body = null, array $curlInfo = [])
+ final public function __construct($status, array $headers = [], string $body = null, array $curlInfo = [])
  {
  $this->setStatus($status);
  $this->headers = $headers;
@@ -57,11 +51,9 @@ public function toArray(): array
  // Base64 encode when binary
  if (
  null !== $this->getContentType()
- &&
- (
+ && (
  str_contains($this->getContentType(), 'application/x-gzip')
- ||
- 'binary' == $this->getHeader('Content-Transfer-Encoding')
+ || 'binary' == $this->getHeader('Content-Transfer-Encoding')
  )
  ) {
  $body = base64_encode($body);
@@ -118,7 +110,7 @@ public function getBody(): string
  /**
  * @return array<string,mixed>|mixed|null
  */
- public function getCurlInfo(?string $option = null)
+ public function getCurlInfo(string $option = null): mixed
  {
  if (empty($option)) {
  return $this->curlInfo;
@@ -157,10 +149,7 @@ public function getHeader(string $key): ?string
  return $this->headers[$key];
  }
 
- /**
- * @return mixed
- */
- public function getHttpVersion()
+ public function getHttpVersion(): mixed
  {
  return $this->httpVersion;
  }

src/VCR/Storage/Blackhole.php

@@ -9,16 +9,10 @@
  */
 class Blackhole implements Storage
 {
- /**
- * {@inheritdoc}
- */
  public function storeRecording(array $recording): void
  {
  }
 
- /**
- * {@inheritdoc}
- */
  public function isNew(): bool
  {
  return true;

src/VCR/Storage/Json.php

@@ -12,9 +12,6 @@
  */
 class Json extends AbstractStorage
 {
- /**
- * {@inheritdoc}
- */
  public function storeRecording(array $recording): void
  {
  fseek($this->handle, -1, \SEEK_END);