Merge pull request #43 from tbreuss/develop

tbreuss · web-flow · commit 1b1a1b67d8d6 · 2025-06-08T09:57:46.000+02:00
Develop
diff --git a/src/Zack.php b/src/Zack.php
@@ -28,12 +28,16 @@ public function __construct(
 
     public function run(): void
     {
-        error_reporting($this->config->php->errorReporting);
+        error_reporting($this->config->php->errorLevel);
         ini_set('display_errors', $this->config->php->displayErrors ? '1' : '0');
         ini_set('display_startup_errors', $this->config->php->displayStartupErrors ? '1' : '0');
         ini_set('log_errors', $this->config->php->logErrors ? '1' : '0');
         ini_set('error_log', $this->config->php->errorLog);
 
+        set_error_handler(function (int $severity, string $message, string $file = '', int $line = 0) {
+            throw new \ErrorException($message, 0, $severity, $file, $line);
+        }, $this->config->php->errorLevel);
+
         $this->initContainer();
 
         $request = HttpFoundation\Request::createFromGlobals();
diff --git a/src/config/PhpConfig.php b/src/config/PhpConfig.php
@@ -4,18 +4,18 @@
 
 readonly class PhpConfig
 {
-    public int $errorReporting;
     public bool $displayErrors;
     public bool $displayStartupErrors;
-    public bool $logErrors;
+    public int $errorLevel;
     public string $errorLog;
+    public bool $logErrors;
 
     public function __construct(array $config, string $logPath)
     {
-        $this->errorReporting = $config['errorReporting'] ?? E_ALL;
         $this->displayErrors = $config['displayErrors'] ?? false;
         $this->displayStartupErrors = $config['displayStartupErrors'] ?? false;
-        $this->logErrors = $config['logErrors'] ?? true;
+        $this->errorLevel = $config['errorLevel'] ?? E_ALL;
         $this->errorLog = $config['errorLog'] ?? $logPath . '/errors.log';
+        $this->logErrors = $config['logErrors'] ?? true;
     }
 }
diff --git a/src/routing/PhpRouteHandler.php b/src/routing/PhpRouteHandler.php
@@ -3,9 +3,12 @@
 namespace tebe\zack\routing;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
+use function tebe\zack\html_extract_title;
+
 class PhpRouteHandler
 {
     private ?ContainerBuilder $container;
@@ -23,19 +26,30 @@ public function __invoke(Request $request): Response
             throw new \Exception('PHP file not found for path: ' . $path);
         }
 
-        $response = require $path;
+        ob_start();
+        $returnValue = require $path;
+        $outputValue = ob_get_clean();
 
-        if (!$response instanceof Response) {
-            throw new \Exception('PHP file must return a response object: ' . $path);
+        if ($returnValue === 1 && is_string($outputValue)) {
+            $title = html_extract_title($outputValue, basename($path));
+            return $this->html('route-handler.html.twig', ['title' => $title, 'html' => $outputValue]);
+        } 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);
+        } elseif (is_array($returnValue)) {
+            return $this->json($returnValue);
+        } elseif ($returnValue instanceof Response) {
+            return $returnValue;
+        } else {
+            throw new \Exception('The PHP file must output something or return a string, an array or a response object: ' . $path);
         }
-
-        return $response;
     }
 
     public function html(string $template, array $context = []): Response
     {
-        $twig = $this->container->get('twig');
-        $html = $twig->render($template, $context);
+        $html = $this->render($template, $context);
         return new Response($html, 200);
     }
 
@@ -46,4 +60,15 @@ public function json(array $context = []): Response
             'Content-Type' => 'application/json',
         ]);
     }
+
+    public function redirect(string $url, int $status = 302): Response
+    {
+        return new RedirectResponse($url, $status);
+    }
+
+    public function render(string $template, array $context = []): string
+    {
+        $twig = $this->container->get('twig');
+        return $twig->render($template, $context);
+    }
 }
diff --git a/tests/_data/routes/articles/[id]/comments.php b/tests/_data/routes/articles/[id]/comments.php
@@ -2,6 +2,6 @@
 
 /** @var tebe\zack\routing\PhpRouteHandler $this */
 
-return $this->html('articles/comments.html.twig', [
+return $this->render('articles/comments.html.twig', [
     'title' => 'GET: Articles.[id].Comments.Php',
 ]);
diff --git a/tests/_data/routes/articles/[id]/comments.post.php b/tests/_data/routes/articles/[id]/comments.post.php
@@ -1,5 +1,7 @@
 <?php declare(strict_types=1);
 
-return new Symfony\Component\HttpFoundation\Response(
-    '<h1>POST: Articles.[id].Comments.Php</h1>',
-);
+/** @var tebe\zack\routing\PhpRouteHandler $this */
+
+return $this->render('articles/comments.html.twig', [
+    'title' => 'POST: Articles.[id].Comments.Php',
+]);
diff --git a/tests/_data/routes/articles/[id]/index.php b/tests/_data/routes/articles/[id]/index.php
@@ -2,6 +2,6 @@
 
 /** @var tebe\zack\routing\PhpRouteHandler $this */
 
-return $this->html('articles/detail.html.twig', [
+return $this->render('articles/detail.html.twig', [
     'title' => 'GET: Articles.[id].Php',
 ]);
diff --git a/tests/_data/routes/articles/index.php b/tests/_data/routes/articles/index.php
@@ -2,6 +2,6 @@
 
 /** @var tebe\zack\routing\PhpRouteHandler $this */
 
-return $this->html('articles/list.html.twig', [
+return $this->render('articles/list.html.twig', [
     'title' => 'GET: Articles.Php',
 ]);
diff --git a/tests/_data/routes/doc-examples/api/ping.php b/tests/_data/routes/doc-examples/api/ping.php
@@ -1,7 +1,3 @@
 <?php declare(strict_types=1);
 
-use Symfony\Component\HttpFoundation\Response;
-
-return new Response('{"ping": "pong"}', 200, [
-    'Content-Type' => 'application/json',
-]);
+return ['ping' => 'pong'];
diff --git a/tests/_data/routes/doc-examples/hello/[name].php b/tests/_data/routes/doc-examples/hello/[name].php
@@ -1,9 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-use Symfony\Component\HttpFoundation\Response;
-
-$name = $request->attributes->get('name');
-
-return new Response('Hello ' . $name . '!', 200);
+<h2>Hello <?= $request->get('name') ?>!</h2>
diff --git a/tests/_data/routes/doc-examples/hello/[name]/[age].php b/tests/_data/routes/doc-examples/hello/[name]/[age].php
@@ -1,10 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-use Symfony\Component\HttpFoundation\Response;
-
-$name = $request->attributes->get('name');
-$age = $request->attributes->get('age');
-
-return new Response("Hello $name! You are $age years old.", 200);
+<h2>Hello <?= $request->get('name') ?>! You are <?= $request->get('age') ?> years old.</h2>
diff --git a/tests/_data/routes/doc-examples/hello/catchall/[...name].php b/tests/_data/routes/doc-examples/hello/catchall/[...name].php
@@ -1,9 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-use Symfony\Component\HttpFoundation\Response;
-
-$name = $request->attributes->get('name');
-
-return new Response("Hello $name!", 200);
+<h2>Hello <?= $request->get('name') ?></h2>
diff --git a/tests/_data/routes/doc-examples/htm-page.htm b/tests/_data/routes/doc-examples/htm-page.htm
@@ -1 +1 @@
-<h1>htm-page</h1>
+<h2>htm-page</h2>
diff --git a/tests/_data/routes/doc-examples/html-page.htm b/tests/_data/routes/doc-examples/html-page.htm
@@ -1 +1 @@
-<h1>html-page</h1>
+<h2>html-page</h2>
diff --git a/tests/_data/routes/doc-examples/index.get.html b/tests/_data/routes/doc-examples/index.get.html
@@ -1 +1 @@
-<h1>Hello World!</h1>
+<h2>Hello World!</h2>
diff --git a/tests/_data/routes/doc-examples/markdown-page.markdown b/tests/_data/routes/doc-examples/markdown-page.markdown
@@ -1 +1 @@
-# markdown-page
+## markdown-page
diff --git a/tests/_data/routes/doc-examples/md-page.md b/tests/_data/routes/doc-examples/md-page.md
@@ -1 +1 @@
-# md-page
+## md-page
diff --git a/tests/_data/routes/doc-examples/php-page.php b/tests/_data/routes/doc-examples/php-page.php
@@ -1,5 +1 @@
-<?php declare(strict_types=1);
-
-use Symfony\Component\HttpFoundation\Response;
-
-return new Response("<h1>php-page</h1>", 200);
+<h2>php-page</h2>
diff --git a/tests/_data/routes/doc-examples/users.post.php b/tests/_data/routes/doc-examples/users.post.php
@@ -1,9 +1,5 @@
 <?php declare(strict_types=1);
 
-use Symfony\Component\HttpFoundation\Response;
-
 // Do something with body like saving it to a database
 
-return new Response('{"updated": true}', 200, [
-    'Content-Type' => 'application/json',
-]);
+return ['updated' => true];
diff --git a/tests/_data/routes/http-method/delete.delete.htm b/tests/_data/routes/http-method/delete.delete.htm
@@ -1 +1 @@
-<h1>delete.delete.htm</h1>
+<h2>delete.delete.htm</h2>
diff --git a/tests/_data/routes/http-method/get.get.htm b/tests/_data/routes/http-method/get.get.htm
@@ -1 +1 @@
-<h1>get.get.htm</h1>
+<h2>get.get.htm</h2>
diff --git a/tests/_data/routes/http-method/options.options.htm b/tests/_data/routes/http-method/options.options.htm
@@ -1 +1 @@
-<h1>options.options.htm</h1>
+<h2>options.options.htm</h2>
diff --git a/tests/_data/routes/http-method/patch.patch.htm b/tests/_data/routes/http-method/patch.patch.htm
@@ -1 +1 @@
-<h1>patch.patch.htm</h1>
+<h2>patch.patch.htm</h2>
diff --git a/tests/_data/routes/http-method/post.post.htm b/tests/_data/routes/http-method/post.post.htm
@@ -1 +1 @@
-<h1>post.post.htm</h1>
+<h2>post.post.htm</h2>
diff --git a/tests/_data/routes/http-method/put.put.htm b/tests/_data/routes/http-method/put.put.htm
@@ -1 +1 @@
-<h1>put.put.htm</h1>
+<h2>put.put.htm</h2>
diff --git a/tests/_data/routes/route-handler-with-method/htm.get.htm b/tests/_data/routes/route-handler-with-method/htm.get.htm
diff --git a/tests/_data/routes/route-handler-with-method/html.get.html b/tests/_data/routes/route-handler-with-method/html.get.html
diff --git a/tests/_data/routes/route-handler-with-method/markdown.get.markdown b/tests/_data/routes/route-handler-with-method/markdown.get.markdown
diff --git a/tests/_data/routes/route-handler-with-method/md.get.md b/tests/_data/routes/route-handler-with-method/md.get.md
diff --git a/tests/_data/routes/route-handler/htm.htm b/tests/_data/routes/route-handler/htm.htm
diff --git a/tests/_data/routes/route-handler/html.html b/tests/_data/routes/route-handler/html.html
diff --git a/tests/_data/routes/route-handler/markdown.markdown b/tests/_data/routes/route-handler/markdown.markdown
diff --git a/tests/_data/routes/route-handler/md.md b/tests/_data/routes/route-handler/md.md
diff --git a/tests/_data/routes/route-handler/php.php b/tests/_data/routes/route-handler/php.php
diff --git a/tests/_data/routes/route-handler/php/echo-string.get.php b/tests/_data/routes/route-handler/php/echo-string.get.php
@@ -0,0 +1 @@
+<h2><?php echo 'Echo' ?> <?= 'string' ?></h2>
diff --git a/tests/_data/routes/route-handler/php/return-array.get.php b/tests/_data/routes/route-handler/php/return-array.get.php
@@ -0,0 +1,3 @@
+<?php declare(strict_types=1);
+
+return ['value' => 'Return array value'];
diff --git a/tests/_data/routes/route-handler/php/return-invalid.get.php b/tests/_data/routes/route-handler/php/return-invalid.get.php
@@ -0,0 +1,3 @@
+<?php declare(strict_types=1);
+
+return true;
diff --git a/tests/_data/routes/route-handler/php/return-response.get.php b/tests/_data/routes/route-handler/php/return-response.get.php
@@ -2,4 +2,4 @@
 
 use Symfony\Component\HttpFoundation\Response;
 
-return new Response('<h1>php.get.php</h1>');
+return new Response('Return response value');
diff --git a/tests/_data/routes/route-handler/php/return-string.get.php b/tests/_data/routes/route-handler/php/return-string.get.php
@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+/** @var tebe\zack\routing\PhpRouteHandler $this */
+
+return $this->render('route-handler.html.twig', [
+    'title' => 'Return string value',
+    'html' => '<h2>Return string value</h2>',
+]);
diff --git a/tests/_data/routes/route-handler/with-method/htm.get.htm b/tests/_data/routes/route-handler/with-method/htm.get.htm
@@ -0,0 +1 @@
+<h2>htm.get.htm</h2>
diff --git a/tests/_data/routes/route-handler/with-method/html.get.html b/tests/_data/routes/route-handler/with-method/html.get.html
@@ -0,0 +1 @@
+<h2>html.get.html</h2>
diff --git a/tests/_data/routes/route-handler/with-method/json.get.json b/tests/_data/routes/route-handler/with-method/json.get.json
diff --git a/tests/_data/routes/route-handler/with-method/markdown.get.markdown b/tests/_data/routes/route-handler/with-method/markdown.get.markdown
@@ -0,0 +1 @@
+## markdown.get.markdown
diff --git a/tests/_data/routes/route-handler/with-method/md.get.md b/tests/_data/routes/route-handler/with-method/md.get.md
@@ -0,0 +1 @@
+## md.get.md
diff --git a/tests/_data/routes/route-handler/with-method/php.get.php b/tests/_data/routes/route-handler/with-method/php.get.php
@@ -0,0 +1 @@
+<h2><?= 'php.get.php' ?></h2>
diff --git a/tests/_data/routes/route-handler/without-method/htm.htm b/tests/_data/routes/route-handler/without-method/htm.htm
@@ -0,0 +1 @@
+<h2>htm.htm</h2>
diff --git a/tests/_data/routes/route-handler/without-method/html.html b/tests/_data/routes/route-handler/without-method/html.html
@@ -0,0 +1 @@
+<h2>html.html</h2>
diff --git a/tests/_data/routes/route-handler/without-method/json.json b/tests/_data/routes/route-handler/without-method/json.json
diff --git a/tests/_data/routes/route-handler/without-method/markdown.markdown b/tests/_data/routes/route-handler/without-method/markdown.markdown
@@ -0,0 +1 @@
+## markdown.markdown
diff --git a/tests/_data/routes/route-handler/without-method/md.md b/tests/_data/routes/route-handler/without-method/md.md
@@ -0,0 +1 @@
+## md.md
diff --git a/tests/_data/routes/route-handler/without-method/php.php b/tests/_data/routes/route-handler/without-method/php.php
@@ -0,0 +1 @@
+<h2><?= 'php.php' ?></h2>
diff --git a/tests/_data/routes/routing/catch-all-params/with-method/[...param].patch.php b/tests/_data/routes/routing/catch-all-params/with-method/[...param].patch.php
@@ -1,7 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value = $request->get('param');
-
-return new Symfony\Component\HttpFoundation\Response('PATCH catch all params ' . $value);
+<h2>PATCH Catch all params <?= $request->get('param') ?></h2>
diff --git a/tests/_data/routes/routing/catch-all-params/with-method/[...param].post.php b/tests/_data/routes/routing/catch-all-params/with-method/[...param].post.php
@@ -1,7 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value = $request->get('param');
-
-return new Symfony\Component\HttpFoundation\Response('POST catch all params ' . $value);
+<h2>POST Catch all params <?= $request->get('param') ?></h2>
diff --git a/tests/_data/routes/routing/catch-all-params/without-method/[...param].php b/tests/_data/routes/routing/catch-all-params/without-method/[...param].php
@@ -1,7 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value = $request->get('param');
-
-return new Symfony\Component\HttpFoundation\Response('Catch all params ' . $value);
+<h2>Catch all params <?= $request->get('param') ?></h2>
diff --git a/tests/_data/routes/routing/file-params/[param1].get.php b/tests/_data/routes/routing/file-params/[param1].get.php
@@ -1,7 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value = $request->get('param1');
-
-return new Symfony\Component\HttpFoundation\Response($value);
+<h2><?= $request->get('param1') ?></h2>
diff --git a/tests/_data/routes/routing/file-params/[param1]/[param2].get.php b/tests/_data/routes/routing/file-params/[param1]/[param2].get.php
@@ -1,8 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value1 = $request->get('param1');
-$value2 = $request->get('param2');
-
-return new Symfony\Component\HttpFoundation\Response($value1 . ' ' . $value2);
+<h2><?= $request->get('param1') ?> <?= $request->get('param2') ?></h2>
diff --git a/tests/_data/routes/routing/file-params/[param1]/[param2]/[param3].get.php b/tests/_data/routes/routing/file-params/[param1]/[param2]/[param3].get.php
@@ -1,9 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value1 = $request->get('param1');
-$value2 = $request->get('param2');
-$value3 = $request->get('param3');
-
-return new Symfony\Component\HttpFoundation\Response($value1 . ' ' . $value2 . ' ' . $value3);
+<h2><?= $request->get('param1') ?> <?= $request->get('param2') ?> <?= $request->get('param3') ?></h2>
diff --git a/tests/_data/routes/routing/path-params/[param1]/[param2]/[param3]/index.get.php b/tests/_data/routes/routing/path-params/[param1]/[param2]/[param3]/index.get.php
@@ -1,9 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value1 = $request->get('param1');
-$value2 = $request->get('param2');
-$value3 = $request->get('param3');
-
-return new Symfony\Component\HttpFoundation\Response($value1 . ' ' . $value2 . ' ' . $value3);
+<h2><?= $request->get('param1') ?> <?= $request->get('param2') ?> <?= $request->get('param3') ?></h2>
diff --git a/tests/_data/routes/routing/path-params/[param1]/[param2]/index.get.php b/tests/_data/routes/routing/path-params/[param1]/[param2]/index.get.php
@@ -1,8 +1,3 @@
-<?php declare(strict_types=1);
+<?php /** @var Symfony\Component\HttpFoundation\Request $request */ ?>
 
-/** @var Symfony\Component\HttpFoundation\Request $request */
-
-$value1 = $request->get('param1');
-$value2 = $request->get('param2');
-
-return new Symfony\Component\HttpFoundation\Response($value1 . ' ' . $value2);
+<h2><?= $request->get('param1') ?> <?= $request->get('param2') ?></h2>
diff --git a/tests/_data/routes/routing/path-params/[param1]/index.get.php b/tests/_data/routes/routing/path-params/[param1]/index.get.php
diff --git a/tests/_data/routes/routing/redirect/301.get.php b/tests/_data/routes/routing/redirect/301.get.php
diff --git a/tests/_data/routes/routing/redirect/302.post.php b/tests/_data/routes/routing/redirect/302.post.php
diff --git a/tests/_data/routes/whoami.get.php b/tests/_data/routes/whoami.get.php
diff --git a/tests/functional/documentation.hurl b/tests/functional/documentation.hurl
diff --git a/tests/functional/http-method.hurl b/tests/functional/http-method.hurl
diff --git a/tests/functional/route-handler.hurl b/tests/functional/route-handler.hurl
diff --git a/tests/functional/routing.hurl b/tests/functional/routing.hurl
diff --git a/website/routes/examples.php b/website/routes/examples.php
diff --git a/website/routes/index.php b/website/routes/index.php

Original file line number	Diff line number	Diff line change
`@@ -4,18 +4,18 @@`
`4`	`4`
`5`	`5`	`readonly class PhpConfig`
`6`	`6`	`{`
`7`		`- public int $errorReporting;`
`8`	`7`	`public bool $displayErrors;`
`9`	`8`	`public bool $displayStartupErrors;`
`10`		`- public bool $logErrors;`
	`9`	`+ public int $errorLevel;`
`11`	`10`	`public string $errorLog;`
	`11`	`+ public bool $logErrors;`
`12`	`12`
`13`	`13`	`public function __construct(array $config, string $logPath)`
`14`	`14`	`{`
`15`		`- $this->errorReporting = $config['errorReporting'] ?? E_ALL;`
`16`	`15`	`$this->displayErrors = $config['displayErrors'] ?? false;`
`17`	`16`	`$this->displayStartupErrors = $config['displayStartupErrors'] ?? false;`
`18`		`- $this->logErrors = $config['logErrors'] ?? true;`
	`17`	`+ $this->errorLevel = $config['errorLevel'] ?? E_ALL;`
`19`	`18`	`$this->errorLog = $config['errorLog'] ?? $logPath . '/errors.log';`
	`19`	`+ $this->logErrors = $config['logErrors'] ?? true;`
`20`	`20`	`}`
`21`	`21`	`}`