Apply same logic in PHP handler for echoing and returning content, add tests

tbreuss · tbreuss · commit cd7809b102ed · 2025-06-15T10:49:21.000+02:00
diff --git a/src/routing/PhpRouteHandler.php b/src/routing/PhpRouteHandler.php
@@ -33,18 +33,12 @@ public function __invoke(Request $request): Response
         $outputValue = ob_get_clean();
 
         if ($returnValue === 1 && is_string($outputValue)) {
-            if (html_contains_full_html($outputValue)) {
-                return new Response($outputValue, 200);
-            } else {
-                $layout = html_extract_layout($outputValue);
-                $title = html_extract_title($outputValue, basename($path));
-                return $this->html($layout, ['title' => $title, 'html' => $outputValue]);
-            }
+            return $this->handleHtml($outputValue, basename($path));
         } elseif (is_string($returnValue)) {
             if (is_string($outputValue) && strlen($outputValue) > 0) {
                 throw new \Exception('In the PHP file the return value must be omitted if an output was made via echo: ' . $path);
             }
-            return new Response($returnValue, 200);
+            return $this->handleHtml($returnValue, basename($path));
         } elseif (is_array($returnValue)) {
             return $this->json($returnValue);
         } elseif ($returnValue instanceof Response) {
@@ -54,6 +48,17 @@ public function __invoke(Request $request): Response
         }
     }
 
+    private function handleHtml(string $content, string $defaultTitle): Response
+    {
+        if (html_contains_full_html($content)) {
+            return new Response($content, 200);
+        } else {
+            $layout = html_extract_layout($content);
+            $title = html_extract_title($content, $defaultTitle);
+            return $this->html($layout, ['title' => $title, 'html' => $content]);
+        }
+    }
+
     public function html(string $template, array $context = []): Response
     {
         $html = $this->render($template, $context);
diff --git a/tests/_data/routes/twig/layout/html-default.get.html b/tests/_data/routes/twig/layout/html-default.get.html
@@ -0,0 +1 @@
+<h2>HTML Default</h2>
diff --git a/tests/_data/routes/twig/layout/html-invalid.get.html b/tests/_data/routes/twig/layout/html-invalid.get.html
@@ -0,0 +1 @@
+<!-- layout: invalid.html.twig -->
diff --git a/tests/_data/routes/twig/layout/html-test.get.html b/tests/_data/routes/twig/layout/html-test.get.html
@@ -0,0 +1,2 @@
+<!-- layout: test.html.twig -->
+<h2>HTML Test</h2>
diff --git a/tests/_data/routes/twig/layout/markdown-default.get.md b/tests/_data/routes/twig/layout/markdown-default.get.md
@@ -0,0 +1 @@
+## Markdown Default
diff --git a/tests/_data/routes/twig/layout/markdown-invalid.get.md b/tests/_data/routes/twig/layout/markdown-invalid.get.md
@@ -0,0 +1 @@
+<!-- layout: invalid.html.twig -->
diff --git a/tests/_data/routes/twig/layout/markdown-test.get.md b/tests/_data/routes/twig/layout/markdown-test.get.md
@@ -0,0 +1,2 @@
+<!-- layout: test.html.twig -->
+## Markdown Test
diff --git a/tests/_data/routes/twig/layout/php-echo-default.get.php b/tests/_data/routes/twig/layout/php-echo-default.get.php
@@ -0,0 +1 @@
+<h2>PHP Echo Default</h2>
diff --git a/tests/_data/routes/twig/layout/php-echo-full.get.php b/tests/_data/routes/twig/layout/php-echo-full.get.php
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<h2>PHP Echo Full</h2>
diff --git a/tests/_data/routes/twig/layout/php-echo-invalid.get.php b/tests/_data/routes/twig/layout/php-echo-invalid.get.php
@@ -0,0 +1 @@
+<!-- layout: invalid.html.twig -->
diff --git a/tests/_data/routes/twig/layout/php-echo-test.get.php b/tests/_data/routes/twig/layout/php-echo-test.get.php
@@ -0,0 +1,2 @@
+<!-- layout: test.html.twig -->
+<h2>PHP Echo Test</h2>
diff --git a/tests/_data/routes/twig/layout/php-return-default.get.php b/tests/_data/routes/twig/layout/php-return-default.get.php
@@ -0,0 +1 @@
+<?php return '<h2>PHP Return Default</h2>';
diff --git a/tests/_data/routes/twig/layout/php-return-full.get.php b/tests/_data/routes/twig/layout/php-return-full.get.php
@@ -0,0 +1,2 @@
+<?php return '<!DOCTYPE html>
+<h2>PHP Return Full</h2>';
diff --git a/tests/_data/routes/twig/layout/php-return-invalid.get.php b/tests/_data/routes/twig/layout/php-return-invalid.get.php
@@ -0,0 +1 @@
+<?php return '<!-- layout: invalid.html.twig -->';
diff --git a/tests/_data/routes/twig/layout/php-return-test.get.php b/tests/_data/routes/twig/layout/php-return-test.get.php
@@ -0,0 +1,2 @@
+<!-- layout: test.html.twig -->
+<h2>PHP Return Test</h2>
diff --git a/tests/functional/twig.hurl b/tests/functional/twig.hurl
@@ -0,0 +1,106 @@
+# Layout
+GET {{host}}/twig/layout/html-default
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>HTML Default - My application</title>"
+body contains "<h2>HTML Default</h2>"
+
+GET {{host}}/twig/layout/html-invalid
+HTTP 500
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Error 500 - My application</title>"
+body contains "<h2>Error 500</h2>"
+body contains "Unable to find template &quot;invalid.html.twig&quot;"
+
+GET {{host}}/twig/layout/html-test
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>HTML Test - My application</title>"
+body contains "<h2>HTML Test</h2>"
+body contains "<h2>test.html.twig</h2>"
+
+GET {{host}}/twig/layout/markdown-default
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Markdown Default - My application</title>"
+body contains "<h2>Markdown Default</h2>"
+
+GET {{host}}/twig/layout/markdown-invalid
+HTTP 500
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Error 500 - My application</title>"
+body contains "<h2>Error 500</h2>"
+body contains "Unable to find template &quot;invalid.html.twig&quot;"
+
+GET {{host}}/twig/layout/markdown-test
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Markdown Test - My application</title>"
+body contains "<h2>Markdown Test</h2>"
+body contains "<h2>test.html.twig</h2>"
+
+GET {{host}}/twig/layout/php-echo-default
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>PHP Echo Default - My application</title>"
+body contains "<h2>PHP Echo Default</h2>"
+
+GET {{host}}/twig/layout/php-echo-full
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body not contains "<title>PHP Echo Full - My application</title>"
+body contains "<h2>PHP Echo Full</h2>"
+
+GET {{host}}/twig/layout/php-echo-invalid
+HTTP 500
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Error 500 - My application</title>"
+body contains "<h2>Error 500</h2>"
+body contains "Unable to find template &quot;invalid.html.twig&quot;"
+
+GET {{host}}/twig/layout/php-echo-test
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>PHP Echo Test - My application</title>"
+body contains "<h2>PHP Echo Test</h2>"
+body contains "<h2>test.html.twig</h2>"
+
+GET {{host}}/twig/layout/php-return-default
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>PHP Return Default - My application</title>"
+body contains "<h2>PHP Return Default</h2>"
+
+GET {{host}}/twig/layout/php-return-full
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body not contains "<title>PHP Return Full - My application</title>"
+body contains "<h2>PHP Return Full</h2>"
+
+GET {{host}}/twig/layout/php-return-invalid
+HTTP 500
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>Error 500 - My application</title>"
+body contains "<h2>Error 500</h2>"
+body contains "Unable to find template &quot;invalid.html.twig&quot;"
+
+GET {{host}}/twig/layout/php-return-test
+HTTP 200
+Content-Type: text/html; charset=UTF-8
+[Asserts]
+body contains "<title>PHP Return Test - My application</title>"
+body contains "<h2>PHP Return Test</h2>"
+body contains "<h2>test.html.twig</h2>"
diff --git a/website/routes/doc.md b/website/routes/doc.md
@@ -331,10 +331,12 @@ The layout is applied and output together with the page title and the HTML conte
 If you want finer control over the HTTP response, you can return a string, an array or a `Symfony\Component\HttpFoundation\Response` object.
 
 If the return value is a string, it is output as HTML with the content type `text/html`.
+The same logic is applied as for echoing content.
 
 If the return value is an array, it is JSON encoded and output with the content-type `application/json`.
 
 If the return value is a `Symfony\Component\HttpFoundation\Response` object, it is output unchanged together with the underlying content type.
+With returning a response object you will have full control over the HTTP response.
 There are several response subclasses to help you return JSON, redirect, stream file downloads and more.
 
 ### Events

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<!-- layout: test.html.twig -->`
	`2`	`+<h2>HTML Test</h2>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<!-- layout: test.html.twig -->`
	`2`	`+## Markdown Test`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<!DOCTYPE html>`
	`2`	`+<h2>PHP Echo Full</h2>`