Adding support for PHP8, dropping support for PHP7

Author: JeroenVanOort

.github/workflows/tests.yml

@@ -17,7 +17,7 @@ jobs:
  - name: "Setup PHP"
  uses: "shivammathur/setup-php@v2"
  with:
- php-version: "7.3"
+ php-version: "8.0"
  extensions: "curl, soap"
  tools: "composer:v2"
 
@@ -40,7 +40,7 @@ jobs:
  - name: "Setup PHP"
  uses: "shivammathur/setup-php@v2"
  with:
- php-version: "7.3"
+ php-version: "8.0"
  extensions: "curl, soap"
  tools: "composer:v2"
 
@@ -57,7 +57,7 @@ jobs:
  strategy:
  fail-fast: true
  matrix:
- php: ["7.3", "7.4"]
+ php: ["8.0"]
  composer_flags: ["", "--prefer-lowest"]
 
  name: "Tests PHP ${{ matrix.php }} ${{ matrix.composer_flags}}"
@@ -92,7 +92,7 @@ jobs:
  strategy:
  fail-fast: true
  matrix:
- guzzle: ["3", "5", "6"]
+ guzzle: ["5", "6"]
 
  name: "Integration test for Guzzle ${{ matrix.guzzle }}"
 
@@ -105,7 +105,7 @@ jobs:
  - name: "Setup PHP"
  uses: "shivammathur/setup-php@v2"
  with:
- php-version: "7.3"
+ php-version: "8.0"
  extensions: "curl, soap"
  tools: "composer:v2"
  coverage: "pcov"
@@ -137,7 +137,7 @@ jobs:
  - name: "Setup PHP"
  uses: "shivammathur/setup-php@v2"
  with:
- php-version: "7.3"
+ php-version: "8.0"
  extensions: "curl, soap"
  tools: "composer:v2"
  coverage: "pcov"

.gitignore

@@ -8,3 +8,4 @@ tests/fixtures/cassette*
 /.php_cs
 composer.lock
 .phpunit.result.cache
+.php-cs-fixer.cache

composer.json

@@ -6,7 +6,7 @@
  "test": "./vendor/bin/phpunit",
  "lint": "./vendor/bin/php-cs-fixer fix --verbose --diff --dry-run",
  "fix": "./vendor/bin/php-cs-fixer fix --verbose --diff",
- "phpstan": "phpstan analyse -c phpstan.neon --no-progress -vvv"
+ "phpstan": "php -d memory_limit=-1 vendor/bin/phpstan analyse -c phpstan.neon --no-progress -vvv"
  },
  "authors": [
  {
@@ -15,20 +15,22 @@
  }
  ],
  "require": {
- "php": ">=7.3",
+ "php": "^8.0",
  "ext-curl": "*",
  "beberlei/assert": "^3.2.5",
- "symfony/yaml": "~2.1|^3.0|^4.0|^5.0",
- "symfony/event-dispatcher": "^2.4|^3.0|^4.0|^5.0"
+ "symfony/yaml": "^3.0|^4.0|^5.0",
+ "symfony/event-dispatcher": "^5.0"
  },
  "require-dev": {
  "phpunit/phpunit": "^8.4.0",
- "mikey179/vfsstream": "^1.6",
- "phpstan/phpstan": "^0.12",
+ "mikey179/vfsstream": "^1.6.10",
+ "phpstan/phpstan": "^0.12.92",
  "phpstan/phpstan-beberlei-assert": "^0.12.0",
  "thecodingmachine/phpstan-strict-rules": "^0.12",
  "sebastian/version": "^1.0.3|^2.0",
- "friendsofphp/php-cs-fixer": "^2.16"
+ "friendsofphp/php-cs-fixer": "^3.0",
+ "phpstan/phpstan-phpunit": "^0.12.22",
+ "phpstan/extension-installer": "^1.1"
  },
  "autoload": {
  "psr-4": {

phpstan.neon

@@ -9,10 +9,3 @@ parameters:
  - "#Access to an undefined property object::\\$datalen\\.#"
  # PHPStan cannot detect that strrpos will succeed (because of Assertion above) in HttpUtil::parseStatus
  - '#Parameter .* \$str(ing)? of function substr expects string, string\|false given.#'
- # The EventDispatcherInterface::dispatch signature is different (!) between Symfony <4.3 and >=4.3
- - '/Parameter #1 \$event of method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface::dispatch\(\) expects object, string\|null given./'
- - '/Parameter #2 \$eventName of method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface::dispatch\(\) expects string\|null, VCR\\Event\\Event given./'
- - '#Call to an undefined method org\\bovigo\\vfs\\vfsStreamContent::hasChild\(\)\.#'
-includes:
- - vendor/thecodingmachine/phpstan-strict-rules/phpstan-strict-rules.neon
- - vendor/phpstan/phpstan-beberlei-assert/extension.neon

resources/docker/workspace/Dockerfile

@@ -1,4 +1,4 @@
-FROM php:7.3-cli-alpine
+FROM php:8.0-cli-alpine
 
 ARG PUID=1000
 ARG PGID=1000

src/VCR/Event/Event.php

@@ -2,19 +2,6 @@
 
 namespace VCR\Event;
 
-use Symfony\Component\EventDispatcher\Event as LegacyEvent;
-use Symfony\Contracts\EventDispatcher\Event as ContractsEvent;
-
-if (class_exists(ContractsEvent::class) && !class_exists(LegacyEvent::class)) {
- abstract class SymphonyEvent extends ContractsEvent
- {
- }
-} elseif (class_exists(LegacyEvent::class)) {
- abstract class SymphonyEvent extends LegacyEvent
- {
- }
-}
-
-abstract class Event extends SymphonyEvent
+abstract class Event extends \Symfony\Contracts\EventDispatcher\Event
 {
 }

src/VCR/LibraryHooks/CurlHook.php

@@ -2,6 +2,7 @@
 
 namespace VCR\LibraryHooks;
 
+use CurlHandle;
 use VCR\CodeTransform\AbstractCodeTransform;
 use VCR\Request;
 use VCR\Response;
@@ -166,15 +167,9 @@ public static function __callStatic($method, array $args)
  }
 
  /**
- * Initialize a cURL session.
- *
  * @see http://www.php.net/manual/en/function.curl-init.php
- *
- * @param string|null $url (Optional) url
- *
- * @return resource|false cURL handle
  */
- public static function curlInit(?string $url = null)
+ public static function curlInit(?string $url = null): CurlHandle|false
  {
  $curlHandle = curl_init($url);
  if (false !== $curlHandle) {
@@ -186,13 +181,9 @@ public static function curlInit(?string $url = null)
  }
 
  /**
- * Reset a cURL session.
- *
  * @see http://www.php.net/manual/en/function.curl-reset.php
- *
- * @param resource $curlHandle a cURL handle returned by curl_init()
  */
- public static function curlReset($curlHandle): void
+ public static function curlReset(CurlHandle $curlHandle): void
  {
  curl_reset($curlHandle);
  self::$requests[(int) $curlHandle] = new Request('GET', null);
@@ -205,13 +196,11 @@ public static function curlReset($curlHandle): void
  *
  * @see http://www.php.net/manual/en/function.curl-exec.php
  *
- * @param resource $curlHandle a cURL handle returned by curl_init()
- *
  * @return mixed Returns TRUE on success or FALSE on failure.
  * However, if the CURLOPT_RETURNTRANSFER option is set, it will return the
  * result on success, FALSE on failure.
  */
- public static function curlExec($curlHandle)
+ public static function curlExec(CurlHandle $curlHandle)
  {
  try {
  $request = self::$requests[(int) $curlHandle];
@@ -330,12 +319,9 @@ public static function curlMultiGetcontent($curlHandle): ?string
  *
  * @see http://www.php.net/manual/en/function.curl-getinfo.php
  *
- * @param resource $curlHandle a cURL handle returned by curl_init()
- * @param int $option a cURL option defined in the cURL Predefined Constants
- *
  * @return mixed
  */
- public static function curlGetinfo($curlHandle, int $option = 0)
+ public static function curlGetinfo(CurlHandle $curlHandle, int $option = 0)
  {
  if (isset(self::$responses[(int) $curlHandle])) {
  return CurlHelper::getCurlOptionFromResponse(
@@ -354,15 +340,11 @@ public static function curlGetinfo($curlHandle, int $option = 0)
  *
  * @see http://www.php.net/manual/en/function.curl-setopt.php
  *
- * @param resource $curlHandle a cURL handle returned by curl_init()
- * @param int $option the CURLOPT_XXX option to set
- * @param mixed $value the value to be set on option
- *
- * @return bool returns TRUE on success or FALSE on failure
+ * @param mixed $value the value to be set on option
  */
- public static function curlSetopt($curlHandle, int $option, $value): bool
+ public static function curlSetopt(CurlHandle $curlHandle, int $option, $value): bool
  {
- CurlHelper::setCurlOptionOnRequest(self::$requests[(int) $curlHandle], $option, $value, $curlHandle);
+ CurlHelper::setCurlOptionOnRequest(self::$requests[(int) $curlHandle], $option, $value);
 
  static::$curlOptions[(int) $curlHandle][$option] = $value;
 
@@ -374,29 +356,21 @@ public static function curlSetopt($curlHandle, int $option, $value): bool
  *
  * @see http://www.php.net/manual/en/function.curl-setopt-array.php
  *
- * @param resource $curlHandle a cURL handle returned by curl_init()
- * @param array<int, mixed> $options an array specifying which options to set and their values
+ * @param array<int, mixed> $options an array specifying which options to set and their values
  */
- public static function curlSetoptArray($curlHandle, array $options): void
+ public static function curlSetoptArray(CurlHandle $curlHandle, array $options): void
  {
- if (\is_array($options)) {
- foreach ($options as $option => $value) {
- static::curlSetopt($curlHandle, $option, $value);
- }
+ foreach ($options as $option => $value) {
+ static::curlSetopt($curlHandle, $option, $value);
  }
  }
 
  /**
  * Return a string containing the last error for the current session.
  *
  * @see https://php.net/manual/en/function.curl-error.php
- *
- * @param resource $curlHandle
- *
- * @return string the error message or '' (the empty string) if no
- * error occurred
  */
- public static function curlError($curlHandle): string
+ public static function curlError(CurlHandle $curlHandle): string
  {
  if (isset(self::$lastErrors[(int) $curlHandle])) {
  return self::$lastErrors[(int) $curlHandle]->getMessage();
@@ -409,13 +383,8 @@ public static function curlError($curlHandle): string
  * Return the last error number.
  *
  * @see https://php.net/manual/en/function.curl-errno.php
- *
- * @param resource $curlHandle
- *
- * @return int the error number or 0 (zero) if no error
- * occurred
  */
- public static function curlErrno($curlHandle): int
+ public static function curlErrno(CurlHandle $curlHandle): int
  {
  if (isset(self::$lastErrors[(int) $curlHandle])) {
  return self::$lastErrors[(int) $curlHandle]->getCode();

src/VCR/LibraryHooks/SoapHook.php

@@ -54,10 +54,8 @@ public function __construct(AbstractCodeTransform $codeTransformer, StreamProces
 
  /**
  * @param array<string,mixed> $options
- *
- * @return string SOAP response
  */
- public function doRequest(string $request, string $location, string $action, int $version, int $one_way = 0, array $options = []): string
+ public function doRequest(string $request, string $location, string $action, int $version, bool $one_way = false, array $options = []): string
  {
  if (self::DISABLED === $this->status) {
  throw new VCRException('Hook must be enabled.', VCRException::LIBRARY_HOOK_DISABLED);

src/VCR/Util/CurlException.php

@@ -2,19 +2,16 @@
 
 namespace VCR\Util;
 
+use CurlHandle;
+
 class CurlException extends \Exception
 {
  /**
  * @var array<string,mixed>
  */
  private $info;
 
- /**
- * @param resource $ch The cURL handler
- *
- * @return CurlException
- */
- public static function create($ch): self
+ public static function create(CurlHandle $ch): self
  {
  $e = new self(curl_error($ch), curl_errno($ch));
  $e->info = curl_getinfo($ch);

src/VCR/Util/CurlHelper.php

@@ -2,6 +2,7 @@
 
 namespace VCR\Util;
 
+use CurlHandle;
 use VCR\Request;
 use VCR\Response;
 
@@ -46,11 +47,9 @@ class CurlHelper
  *
  * The response header might be passed to a custom function.
  *
- * @param Response $response response which contains the response body
  * @param array<int, mixed> $curlOptions cURL options which are not stored within the Response
- * @param resource $ch cURL handle to add headers if needed
  */
- public static function handleOutput(Response $response, array $curlOptions, $ch): ?string
+ public static function handleOutput(Response $response, array $curlOptions, CurlHandle $ch): ?string
  {
  // If there is a header function set, feed the http status and headers to it.
  if (isset($curlOptions[\CURLOPT_HEADERFUNCTION])) {
@@ -129,14 +128,9 @@ public static function getCurlOptionFromResponse(Response $response, int $option
  }
 
  /**
- * Sets a cURL option on a Request.
- *
- * @param Request $request request to set cURL option to
- * @param int $option cURL option to set
- * @param mixed $value value of the cURL option
- * @param resource $curlHandle cURL handle where this option is set on (optional)
+ * @param mixed $value value of the cURL option
  */
- public static function setCurlOptionOnRequest(Request $request, int $option, $value, $curlHandle = null): void
+ public static function setCurlOptionOnRequest(Request $request, int $option, $value): void
  {
  switch ($option) {
  case \CURLOPT_URL:
@@ -194,11 +188,8 @@ public static function setCurlOptionOnRequest(Request $request, int $option, $va
  /**
  * Makes sure we've properly handled the POST body, such as ensuring that
  * CURLOPT_INFILESIZE is set if CURLOPT_READFUNCTION is set.
- *
- * @param Request $request request to set cURL option to
- * @param resource $curlHandle cURL handle associated with the request
  */
- public static function validateCurlPOSTBody(Request $request, $curlHandle = null): void
+ public static function validateCurlPOSTBody(Request $request, CurlHandle $curlHandle = null): void
  {
  $readFunction = $request->getCurlOption(\CURLOPT_READFUNCTION);
  if (null === $readFunction) {
@@ -221,13 +212,12 @@ public static function validateCurlPOSTBody(Request $request, $curlHandle = null
  * A wrapper around call_user_func that attempts to properly handle private
  * and protected methods on objects.
  *
- * @param mixed $callback The callable to pass to call_user_func
- * @param resource $curlHandle cURL handle associated with the request
- * @param mixed $argument The third argument to pass to call_user_func
+ * @param mixed $callback The callable to pass to call_user_func
+ * @param mixed $argument The third argument to pass to call_user_func
  *
  * @return mixed value returned by the callback function
  */
- private static function callFunction($callback, $curlHandle, $argument)
+ private static function callFunction($callback, CurlHandle $curlHandle, $argument)
  {
  if (!\is_callable($callback) && \is_array($callback) && 2 === \count($callback)) {
  // This is probably a private or protected method on an object. Try and