Add var dump handling

bencroker · bencroker · commit d0acc390a08f · 2025-08-23T13:38:06.000+02:00
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "putyourlightson/craft-datastar-module",
   "description": "A template-driven, reactive hypermedia framework for Craft.",
-  "version": "1.0.0-RC.8",
+  "version": "1.0.0-RC.9",
   "type": "yii-module",
   "license": "mit",
   "require": {
diff --git a/src/Datastar.php b/src/Datastar.php
@@ -8,6 +8,7 @@
 use Craft;
 use craft\web\Response;
 use putyourlightson\datastar\assets\DatastarAssetBundle;
+use putyourlightson\datastar\dumpers\SseDumper;
 use putyourlightson\datastar\models\Settings;
 use putyourlightson\datastar\services\SseService;
 use putyourlightson\datastar\twigextensions\DatastarTwigExtension;
@@ -66,6 +67,7 @@ public function init(): void
 
         $this->registerComponents();
         $this->registerTwigExtension();
+        $this->registerSseDumper();
         $this->registerScript();
     }
 
@@ -90,6 +92,15 @@ private function registerTwigExtension(): void
         Craft::$app->getView()->registerTwigExtension(new DatastarTwigExtension());
     }
 
+    private function registerSseDumper(): void
+    {
+        if (empty(Craft::$app->getRequest()->getHeaders()->get('Datastar-Request'))) {
+            return;
+        }
+
+        Craft::$app->set('dumper', new SseDumper());
+    }
+
     private function registerScript(): void
     {
         if (!$this->settings->registerScript) {
diff --git a/src/dumpers/SseDumper.php b/src/dumpers/SseDumper.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * @copyright Copyright (c) PutYourLightsOn
+ */
+
+namespace putyourlightson\datastar\dumpers;
+
+use putyourlightson\datastar\Datastar;
+use Symfony\Component\VarDumper\Cloner\Data;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
+
+class SseDumper extends HtmlDumper
+{
+    public function dump(Data $data, $output = null, array $extraDisplayOptions = []): ?string
+    {
+        $result = parent::dump($data, true, $extraDisplayOptions);
+
+        Datastar::getInstance()->sse->dump($result);
+
+        return $result;
+    }
+}
diff --git a/src/services/SseService.php b/src/services/SseService.php
@@ -12,6 +12,7 @@
 use Exception;
 use putyourlightson\datastar\Datastar;
 use putyourlightson\datastar\helpers\Request;
+use starfederation\datastar\enums\ElementPatchMode;
 use starfederation\datastar\events\EventInterface;
 use starfederation\datastar\events\ExecuteScript;
 use starfederation\datastar\events\Location;
@@ -304,6 +305,21 @@ public function throwException(Throwable $exception): void
         exit(1);
     }
 
+    /**
+     * Prepends dumped content to the `<body>` tag.
+     */
+    public function dump(string $output): void
+    {
+        $this->patchElements($output, [
+            'selector' => 'body',
+            'mode' => ElementPatchMode::Prepend,
+        ]);
+
+        if (!$this->isStreamedResponse) {
+            $this->getEventStream()->send();
+        }
+    }
+
     /**
      * Returns patch event options with null values removed.
      */

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "putyourlightson/craft-datastar-module",`
`3`	`3`	`"description": "A template-driven, reactive hypermedia framework for Craft.",`
`4`		`- "version": "1.0.0-RC.8",`
	`4`	`+ "version": "1.0.0-RC.9",`
`5`	`5`	`"type": "yii-module",`
`6`	`6`	`"license": "mit",`
`7`	`7`	`"require": {`