SoapClient - use CompatTrait to gracefully handle php 8.5's __doRequest signature update

Author: bkdotcom

src/Debug/Collector/SoapClient.php

@@ -13,6 +13,7 @@
 use bdk\Debug;
 use bdk\Debug\Abstraction\Abstraction;
 use bdk\Debug\Abstraction\Type;
+use bdk\Debug\Collector\SoapClient\CompatTrait;
 use DOMDocument;
 use Exception;
 use ReflectionClass;
@@ -28,6 +29,8 @@
  */
 class SoapClient extends SoapClientBase
 {
+    use CompatTrait;
+
     /** @var Debug */
     private $debug;
 
@@ -101,32 +104,6 @@ public function __call($name, $args)
         return $return;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    #[\ReturnTypeWillChange]
-    public function __doRequest($request, $location, $action, $version, $oneWay = 0, $uriParserClass = null)
-    {
-        $exception = null;
-        try {
-            $xmlResponse = PHP_VERSION_ID >= 80500
-                ? parent::__doRequest($request, $location, $action, $version, $oneWay, $uriParserClass)
-                : parent::__doRequest($request, $location, $action, $version, $oneWay);
-        } catch (SoapFault $e) {
-            // we'll rethrow bellow
-        }
-        $this->setLastRequest($request);
-        $this->setLastResponse($xmlResponse);
-        if ($this->isViaCall() === false) {
-            // __doRequest called directly
-            $this->logReqRes($action, $exception, true);
-        }
-        if ($exception) {
-            throw $exception;
-        }
-        return $xmlResponse;
-    }
-
     /**
      * Get defined types keyed by name
      *
@@ -239,6 +216,44 @@ private function debugGetXmlResponse(&$faultInfo)
         return $this->dom->saveXML();
     }
 
+    /**
+     * Handle __doRequest
+     *
+     * @param string      $request        The XML SOAP request.
+     * @param string      $location       The URL to request.
+     * @param string      $action         The SOAP action.
+     * @param int         $version        The SOAP version.
+     * @param bool        $oneWay         If set to true, this method returns nothing.
+     *                                      Use this where a response is not expected.
+     * @param string|null $uriParserClass (PHP 8.5+) URI parser class
+     *
+     * @return string|null The XML SOAP response.
+     *
+     * @throws Exception
+     */
+    #[\ReturnTypeWillChange]
+    private function doDoRequest($request, $location, $action, $version, $oneWay = false, $uriParserClass = null)
+    {
+        $exception = null;
+        try {
+            $xmlResponse = PHP_VERSION_ID >= 80500
+                ? parent::__doRequest($request, $location, $action, $version, $oneWay, $uriParserClass)
+                : parent::__doRequest($request, $location, $action, $version, $oneWay);
+        } catch (SoapFault $e) {
+            // we'll rethrow bellow
+        }
+        $this->setLastRequest($request);
+        $this->setLastResponse($xmlResponse);
+        if ($this->isViaCall() === false) {
+            // __doRequest called directly
+            $this->logReqRes($action, $exception, true);
+        }
+        if ($exception) {
+            throw $exception;
+        }
+        return $xmlResponse;
+    }
+
     /**
      * Check if __call is in backtrace
      *

src/Debug/Collector/SoapClient/CompatTrait.php

@@ -0,0 +1,49 @@
+<?php // phpcs:ignore PSR1.Files.SideEffects.FoundWithSymbol
+
+/**
+ * @package   bdk/debug
+ * @author    Brad Kent <bkfake-github@yahoo.com>
+ * @license   http://opensource.org/licenses/MIT MIT
+ * @copyright 2024-2025 Brad Kent
+ * @since     3.5.1
+ */
+
+ /*
+    PHP 8.5 updates __doRequest signature
+ */
+
+namespace bdk\Debug\Collector\SoapClient;
+
+$traitExists = \trait_exists(__NAMESPACE__ . '\\CompatTrait', false);
+
+if (PHP_VERSION_ID >= 80400 && !$traitExists) {
+    /**
+     * @phpcs:disable Generic.Classes.DuplicateClassName.Found
+     */
+    trait CompatTrait
+    {
+        /**
+         * {@inheritDoc}
+         */
+        #[\ReturnTypeWillChange]
+        public function __doRequest($request, $location, $action, $version, $oneWay = 0, $uriParserClass = null)
+        {
+            return $this->doDoRequest($request, $location, $action, $version, $oneWay, $uriParserClass);
+        }
+    }
+} elseif (!$traitExists) {
+    /**
+     * @phpcs:disable Generic.Classes.DuplicateClassName.Found
+     */
+    trait CompatTrait
+    {
+        /**
+         * {@inheritDoc}
+         */
+        #[\ReturnTypeWillChange]
+        public function __doRequest($request, $location, $action, $version, $oneWay = 0)
+        {
+            return $this->doDoRequest($request, $location, $action, $version, $oneWay);
+        }
+    }
+}

tests/Debug/Helper.php

@@ -90,7 +90,7 @@ public static function logEntryToArray($logEntry, $withKeys = true, $dropEmptyMe
         }
         return $withKeys
             ? $return
-            : array_values($return);
+            : \array_values($return);
     }
 
     public function resetContainerValue($name)