add support for curl_multi_getcontent

s

Author: Khartir

src/VCR/CodeTransform/CurlCodeTransform.php

@@ -21,6 +21,7 @@ class CurlCodeTransform extends AbstractCodeTransform
  '/(?<!::|->|\w_)\\\?curl_multi_remove_handle\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_multi_remove_handle(',
  '/(?<!::|->|\w_)\\\?curl_multi_exec\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_multi_exec(',
  '/(?<!::|->|\w_)\\\?curl_multi_info_read\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_multi_info_read(',
+ '/(?<!::|->|\w_)\\\?curl_multi_getcontent\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_multi_getcontent(',
  '/(?<!::|->|\w_)\\\?curl_reset\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_reset(',
  '/(?<!::|->|\w_)\\\?curl_error\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_error(',
  '/(?<!::|->|\w_)\\\?curl_errno\s*\(/i' => '\VCR\LibraryHooks\CurlHook::curl_errno(',

src/VCR/LibraryHooks/CurlHook.php

@@ -37,7 +37,7 @@ class CurlHook implements LibraryHook
  protected static $responses = [];
 
  /**
- * @var array<int,mixed> additinal curl options, which are not stored within a request
+ * @var array<int,mixed> additional curl options, which are not stored within a request
  */
  protected static $curlOptions = [];
 
@@ -51,6 +51,11 @@ class CurlHook implements LibraryHook
  */
  protected static $multiExecLastChs = [];
 
+ /**
+ * @var array<int, string|null> return values of curl_multi responses
+ */
+ protected static $multiReturnValues = [];
+
  /**
  * @var CurlException[] last cURL error, as a CurlException
  */
@@ -276,7 +281,7 @@ public static function curlMultiExec($multiHandle, ?int &$stillRunning): int
  foreach (self::$multiHandles[(int) $multiHandle] as $curlHandle) {
  if (!isset(self::$responses[(int) $curlHandle])) {
  self::$multiExecLastChs[] = $curlHandle;
- self::curlExec($curlHandle);
+ self::$multiReturnValues[(int) $curlHandle] = self::curlExec($curlHandle);
  }
  }
  }
@@ -306,6 +311,20 @@ public static function curlMultiInfoRead()
  return false;
  }
 
+ /**
+ * Return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set.
+ *
+ * @see https://www.php.net/manual/en/function.curl-multi-getcontent.php
+ *
+ * @param resource $curlHandle
+ *
+ * @return string|null return the content of a cURL handle if CURLOPT_RETURNTRANSFER is set
+ */
+ public static function curlMultiGetcontent($curlHandle): ?string
+ {
+ return self::$multiReturnValues[(int) $curlHandle] ?? null;
+ }
+
  /**
  * Get information regarding a specific transfer.
  *

tests/VCR/LibraryHooks/CurlHookTest.php

@@ -373,6 +373,78 @@ function () use ($testClass): void {
  curl_multi_close($curlMultiHandle);
  }
 
+ public function testShouldReturnMultiCallValues(): void
+ {
+ $testClass = $this;
+ $callCount = 0;
+ $this->curlHook->enable(
+ function (Request $request) use ($testClass, &$callCount) {
+ $testClass->assertEquals(
+ 'example.com',
+ $request->getHost(),
+ ''
+ );
+ ++$callCount;
+
+ return new Response('200', [], $testClass->expected.$callCount);
+ }
+ );
+
+ $curlHandle1 = curl_init('http://example.com');
+ Assertion::isResource($curlHandle1);
+ curl_setopt($curlHandle1, \CURLOPT_RETURNTRANSFER, true);
+ $curlHandle2 = curl_init('http://example.com');
+ Assertion::isResource($curlHandle2);
+ curl_setopt($curlHandle2, \CURLOPT_RETURNTRANSFER, true);
+ $curlHandle3 = curl_init('http://example.com');
+ Assertion::isResource($curlHandle3);
+ curl_setopt($curlHandle3, \CURLOPT_RETURNTRANSFER, false);
+
+ $curlMultiHandle = curl_multi_init();
+ Assertion::isResource($curlMultiHandle);
+ curl_multi_add_handle($curlMultiHandle, $curlHandle1);
+ curl_multi_add_handle($curlMultiHandle, $curlHandle2);
+ curl_multi_add_handle($curlMultiHandle, $curlHandle3);
+
+ $stillRunning = null;
+ ob_start();
+ curl_multi_exec($curlMultiHandle, $stillRunning);
+ $output = ob_get_contents();
+ ob_end_clean();
+
+ $returnValue1 = curl_multi_getcontent($curlHandle1);
+ $returnValue2 = curl_multi_getcontent($curlHandle2);
+ $returnValue3 = curl_multi_getcontent($curlHandle3);
+
+ curl_multi_remove_handle($curlMultiHandle, $curlHandle1);
+ curl_multi_remove_handle($curlMultiHandle, $curlHandle2);
+ curl_multi_remove_handle($curlMultiHandle, $curlHandle3);
+ curl_multi_close($curlMultiHandle);
+
+ $this->curlHook->disable();
+
+ $this->assertEquals(3, $callCount, 'Hook should have been called thrice.');
+ $this->assertSame(
+ $this->expected.'1',
+ $returnValue1,
+ 'When called with the first handle the curl_multi_getcontent should return the body of the first response.'
+ );
+
+ $this->assertSame(
+ $this->expected.'2',
+ $returnValue2,
+ 'When called with the second handle the curl_multi_getcontent should return the body of the second response.'
+ );
+
+ $this->assertNull($returnValue3, 'When called with the third handle the curl_multi_getcontent should return null.');
+
+ $this->assertSame(
+ $this->expected.'3',
+ $output,
+ 'The third response was not written on stdout.'
+ );
+ }
+
  /**
  * @requires PHP 5.5.0
  */