Stream & Composite handlers

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.7.0 under development
 
+- New #95: Add `UdpHandler` and `CompositeHandler` (@xepozz)
 - Enh #94: Add a middleware handler to control dumps' output destination (@xepozz)
 - New #94: Add `dump` function (@xepozz)
 

README.md

@@ -100,6 +100,17 @@ In the above `asJson()` will give you nicely formatted code. You can remove form
 
 `$depth` argument allows you to set maximum recursion depth.
 
+## Output destination
+
+Choose one of existing or create a new one class to control the destination where "dumps" will be sent to:
+- [EchoHandler](./src/Handler/EchoHandler.php) 
+  - Uses `echo` to write to stdout stream.
+  - Uses by default.
+- [UdpHandler](./src/Handler/UdpHandler.php)
+  - Uses `ext-sockets` to sent encoded with `json_encode` dumps to a UDP socket.
+- [CompositeHandler](./src/Handler/CompositeHandler.php)
+  - Helpful class to sent dumps to multiple handlers in a row, for example `EchoHandler` and `UdpHandler`.
+
 ## Limitations
 
 Current limitations are:

composer.json

@@ -33,6 +33,9 @@
         "spatie/phpunit-watcher": "^1.23",
         "vimeo/psalm": "^4.30|^5.3"
     },
+    "suggest": {
+        "ext-sockets": "Send dumps to a server through UDP protocol"
+    },
     "autoload": {
         "psr-4": {
             "Yiisoft\\VarDumper\\": "src"

src/Handler/CompositeHandler.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\VarDumper\Handler;
+
+use Yiisoft\VarDumper\HandlerInterface;
+
+final class CompositeHandler implements HandlerInterface
+{
+    /**
+     * @param HandlerInterface[] $handlers
+     */
+    public function __construct(
+        private array $handlers
+    ) {
+    }
+
+    public function handle(mixed $variable, int $depth, bool $highlight = false): void
+    {
+        foreach ($this->handlers as $handler) {
+            $handler->handle($variable, $depth, $highlight);
+        }
+    }
+}

src/Handler/UdpHandler.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\VarDumper\Handler;
+
+use Exception;
+use RuntimeException;
+use Socket;
+use Yiisoft\VarDumper\HandlerInterface;
+
+final class UdpHandler implements HandlerInterface
+{
+    private ?Socket $socket = null;
+
+    public function __construct(
+        private string $host,
+        private int $port,
+    ) {
+        if (!extension_loaded('sockets')) {
+            throw new Exception('The "ext-socket" extension is not installed.');
+        }
+    }
+
+    /**
+     * Sends encode with {@see \json_encode()} function $variable to a UDP socket.
+     */
+    public function handle(mixed $variable, int $depth, bool $highlight = false): void
+    {
+        $socket = $this->getSocket();
+
+        $data = json_encode($variable);
+        if (!socket_sendto($socket, $data, strlen($data), 0, $this->host, $this->port)) {
+            throw new RuntimeException(
+                sprintf(
+                    'Could not send a dump to %s:%d',
+                    $this->host,
+                    $this->port,
+                )
+            );
+        }
+    }
+
+    /**
+     * @throws RuntimeException When a connection cannot be opened.
+     */
+    private function getSocket(): Socket
+    {
+        if ($this->socket === null) {
+            $this->socket = socket_create(AF_INET, SOCK_DGRAM, SOL_UDP);
+            if (!$this->socket) {
+                throw new RuntimeException('Cannot create a UDP socket connection.');
+            }
+        }
+        return $this->socket;
+    }
+}