📦 [php-http#458] Introduce property types, use PHP 8.1 features (CPP, short arrow function, readonly properties, etc)

Author: Andrii

src/ClientFactory/BuzzFactory.php

@@ -13,14 +13,8 @@
  */
 class BuzzFactory implements ClientFactory
 {
-    /**
-     * @var ResponseFactoryInterface
-     */
-    private $responseFactory;
-
-    public function __construct(ResponseFactoryInterface $responseFactory)
+    public function __construct(private readonly ResponseFactoryInterface $responseFactory)
     {
-        $this->responseFactory = $responseFactory;
     }
 
     /**

src/ClientFactory/CurlFactory.php

@@ -13,20 +13,8 @@
  */
 class CurlFactory implements ClientFactory
 {
-    /**
-     * @var ResponseFactoryInterface
-     */
-    private $responseFactory;
-
-    /**
-     * @var StreamFactoryInterface
-     */
-    private $streamFactory;
-
-    public function __construct(ResponseFactoryInterface $responseFactory, StreamFactoryInterface $streamFactory)
+    public function __construct(private readonly ResponseFactoryInterface $responseFactory, private readonly StreamFactoryInterface $streamFactory)
     {
-        $this->responseFactory = $responseFactory;
-        $this->streamFactory = $streamFactory;
     }
 
     /**

src/ClientFactory/MockFactory.php

@@ -12,10 +12,7 @@
  */
 final class MockFactory implements ClientFactory
 {
-    /**
-     * @var ClientInterface
-     */
-    private $client;
+    private ?ClientInterface $client = null;
 
     /**
      * Set the client instance that this factory should return.

src/ClientFactory/SymfonyFactory.php

@@ -14,20 +14,8 @@
  */
 class SymfonyFactory implements ClientFactory
 {
-    /**
-     * @var ResponseFactoryInterface
-     */
-    private $responseFactory;
-
-    /**
-     * @var StreamFactoryInterface
-     */
-    private $streamFactory;
-
-    public function __construct(ResponseFactoryInterface $responseFactory, StreamFactoryInterface $streamFactory)
+    public function __construct(private readonly ResponseFactoryInterface $responseFactory, private readonly StreamFactoryInterface $streamFactory)
     {
-        $this->responseFactory = $responseFactory;
-        $this->streamFactory = $streamFactory;
     }
 
     /**

src/Collector/Collector.php

@@ -21,20 +21,18 @@
  */
 class Collector extends DataCollector
 {
-    /**
-     * @var Stack|null
-     */
-    private $activeStack;
-
-    /**
-     * @var int|null
-     */
-    private $capturedBodyLength;
+    private ?Stack $activeStack = null;
 
-    public function __construct(?int $capturedBodyLength = null)
+    public function __construct(private ?int $capturedBodyLength = null)
     {
         $this->reset();
-        $this->capturedBodyLength = $capturedBodyLength;
+    }
+
+    public function __wakeup(): void
+    {
+        $this->capturedBodyLength = null;
+
+        parent::__wakeup();
     }
 
     /**
@@ -97,9 +95,7 @@ public function addStack(Stack $stack)
      */
     public function getChildrenStacks(Stack $parent)
     {
-        return array_filter($this->data['stacks'], function (Stack $stack) use ($parent) {
-            return $stack->getParent() === $parent;
-        });
+        return array_filter($this->data['stacks'], fn(Stack $stack) => $stack->getParent() === $parent);
     }
 
     /**
@@ -115,33 +111,25 @@ public function getStacks()
      */
     public function getSuccessfulStacks()
     {
-        return array_filter($this->data['stacks'], function (Stack $stack) {
-            return !$stack->isFailed();
-        });
+        return array_filter($this->data['stacks'], fn(Stack $stack) => !$stack->isFailed());
     }
 
     /**
      * @return Stack[]
      */
     public function getFailedStacks()
     {
-        return array_filter($this->data['stacks'], function (Stack $stack) {
-            return $stack->isFailed();
-        });
+        return array_filter($this->data['stacks'], fn(Stack $stack) => $stack->isFailed());
     }
 
     /**
      * @return array
      */
     public function getClients()
     {
-        $stacks = array_filter($this->data['stacks'], function (Stack $stack) {
-            return null === $stack->getParent();
-        });
+        $stacks = array_filter($this->data['stacks'], fn(Stack $stack) => null === $stack->getParent());
 
-        return array_unique(array_map(function (Stack $stack) {
-            return $stack->getClient();
-        }, $stacks));
+        return array_unique(array_map(fn(Stack $stack) => $stack->getClient(), $stacks));
     }
 
     /**
@@ -151,9 +139,7 @@ public function getClients()
      */
     public function getClientRootStacks($client)
     {
-        return array_filter($this->data['stacks'], function (Stack $stack) use ($client) {
-            return $stack->getClient() == $client && null == $stack->getParent();
-        });
+        return array_filter($this->data['stacks'], fn(Stack $stack) => $stack->getClient() == $client && null == $stack->getParent());
     }
 
     /**
@@ -165,9 +151,7 @@ public function getClientRootStacks($client)
      */
     public function countClientMessages($client)
     {
-        return array_sum(array_map(function (Stack $stack) {
-            return $this->countStackMessages($stack);
-        }, $this->getClientRootStacks($client)));
+        return array_sum(array_map(fn(Stack $stack) => $this->countStackMessages($stack), $this->getClientRootStacks($client)));
     }
 
     /**
@@ -177,19 +161,15 @@ public function countClientMessages($client)
      */
     private function countStackMessages(Stack $stack)
     {
-        return 1 + array_sum(array_map(function (Stack $child) {
-            return $this->countStackMessages($child);
-        }, $this->getChildrenStacks($stack)));
+        return 1 + array_sum(array_map(fn(Stack $child) => $this->countStackMessages($child), $this->getChildrenStacks($stack)));
     }
 
     /**
      * @return int
      */
     public function getTotalDuration()
     {
-        return array_reduce($this->data['stacks'], function ($carry, Stack $stack) {
-            return $carry + $stack->getDuration();
-        }, 0);
+        return array_reduce($this->data['stacks'], fn($carry, Stack $stack) => $carry + $stack->getDuration(), 0);
     }
 
     /**

src/Collector/Formatter.php

@@ -23,20 +23,8 @@
  */
 class Formatter implements MessageFormatter
 {
-    /**
-     * @var MessageFormatter
-     */
-    private $formatter;
-
-    /**
-     * @var CurlCommandFormatter
-     */
-    private $curlFormatter;
-
-    public function __construct(MessageFormatter $formatter, MessageFormatter $curlFormatter)
+    public function __construct(private readonly MessageFormatter $formatter, private readonly MessageFormatter $curlFormatter)
     {
-        $this->formatter = $formatter;
-        $this->curlFormatter = $curlFormatter;
     }
 
     /**
@@ -54,7 +42,7 @@ public function formatException(\Throwable $exception)
             return sprintf('Transfer error: %s', $exception->getMessage());
         }
 
-        return sprintf('Unexpected exception of type "%s": %s', get_class($exception), $exception->getMessage());
+        return sprintf('Unexpected exception of type "%s": %s', $exception::class, $exception->getMessage());
     }
 
     /**

src/Collector/PluginClientFactory.php

@@ -20,26 +20,8 @@
  */
 final class PluginClientFactory
 {
-    /**
-     * @var Collector
-     */
-    private $collector;
-
-    /**
-     * @var Formatter
-     */
-    private $formatter;
-
-    /**
-     * @var Stopwatch
-     */
-    private $stopwatch;
-
-    public function __construct(Collector $collector, Formatter $formatter, Stopwatch $stopwatch)
+    public function __construct(private readonly Collector $collector, private readonly Formatter $formatter, private readonly Stopwatch $stopwatch)
     {
-        $this->collector = $collector;
-        $this->formatter = $formatter;
-        $this->stopwatch = $stopwatch;
     }
 
     /**
@@ -56,9 +38,7 @@ public function __construct(Collector $collector, Formatter $formatter, Stopwatc
      */
     public function createClient($client, array $plugins = [], array $options = [])
     {
-        $plugins = array_map(function (Plugin $plugin) {
-            return new ProfilePlugin($plugin, $this->collector, $this->formatter);
-        }, $plugins);
+        $plugins = array_map(fn(Plugin $plugin) => new ProfilePlugin($plugin, $this->collector, $this->formatter), $plugins);
 
         $clientName = $options['client_name'] ?? 'Default';
         array_unshift($plugins, new StackPlugin($this->collector, $this->formatter, $clientName));

src/Collector/PluginClientFactoryListener.php

@@ -19,22 +19,16 @@
  */
 final class PluginClientFactoryListener implements EventSubscriberInterface
 {
-    /**
-     * @var PluginClientFactory
-     */
-    private $factory;
-
-    public function __construct(PluginClientFactory $factory)
+    public function __construct(private readonly PluginClientFactory $factory)
     {
-        $this->factory = $factory;
     }
 
     /**
      * Make sure to profile clients created using PluginClientFactory.
      */
     public function onEvent(Event $e)
     {
-        DefaultPluginClientFactory::setFactory([$this->factory, 'createClient']);
+        DefaultPluginClientFactory::setFactory($this->factory->createClient(...));
     }
 
     /**

src/Collector/Profile.php

@@ -13,32 +13,14 @@
  */
 final class Profile
 {
-    /**
-     * @var string
-     */
-    private $plugin;
+    private string $request;
 
-    /**
-     * @var string
-     */
-    private $request;
+    private string $response;
 
-    /**
-     * @var string
-     */
-    private $response;
+    private bool $failed = false;
 
-    /**
-     * @var bool
-     */
-    private $failed = false;
-
-    /**
-     * @param string $plugin
-     */
-    public function __construct($plugin)
+    public function __construct(private readonly string $plugin)
     {
-        $this->plugin = $plugin;
     }
 
     /**

src/Collector/ProfileClient.php

@@ -26,47 +26,23 @@ class ProfileClient implements ClientInterface, HttpAsyncClient
 {
     use VersionBridgeClient;
 
-    /**
-     * @var ClientInterface&HttpAsyncClient
-     */
-    private $client;
+    private ClientInterface&HttpAsyncClient $client;
 
-    /**
-     * @var Collector
-     */
-    private $collector;
-
-    /**
-     * @var Formatter
-     */
-    private $formatter;
-
-    /**
-     * @var Stopwatch
-     */
-    private $stopwatch;
-
-    /**
-     * @var array
-     */
-    private $eventNames = [];
+    private array $eventNames = [];
 
     private const STOPWATCH_CATEGORY = 'httplug';
 
     /**
      * @param ClientInterface|HttpAsyncClient $client The client to profile. Client must implement HttpClient or
      *                                                HttpAsyncClient interface.
      */
-    public function __construct($client, Collector $collector, Formatter $formatter, Stopwatch $stopwatch)
+    public function __construct($client, private readonly Collector $collector, private readonly Formatter $formatter, private readonly Stopwatch $stopwatch)
     {
         if (!($client instanceof ClientInterface && $client instanceof HttpAsyncClient)) {
             $client = new FlexibleHttpClient($client);
         }
 
         $this->client = $client;
-        $this->collector = $collector;
-        $this->formatter = $formatter;
-        $this->stopwatch = $stopwatch;
     }
 
     public function sendAsyncRequest(RequestInterface $request)
@@ -92,7 +68,7 @@ public function sendAsyncRequest(RequestInterface $request)
             return $response;
         };
 
-        $onRejected = function (\Exception $exception) use ($event, $stack) {
+        $onRejected = function (\Exception $exception) use ($event, $stack): void {
             $this->collectExceptionInformations($exception, $event, $stack);
             $event->stop();