From 5a467ae38de2212e31fb2d881ae0a410053e35de Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Wed, 25 Sep 2024 10:57:52 +0200
Subject: [PATCH] Add ChillUrlGenerator and ChillUrlGeneratorInterface

Introduced a new interface ChillUrlGeneratorInterface for URL generation with return path handling. Implemented this interface in the ChillUrlGenerator class, which uses Symfony components to manage URL generation and request information.
---
 .../Routing/ChillUrlGenerator.php             | 43 +++++++++++++++++++
 .../Routing/ChillUrlGeneratorInterface.php    | 35 +++++++++++++++
 .../config/services/routing.yaml              |  5 +++
 3 files changed, 83 insertions(+)
 create mode 100644 src/Bundle/ChillMainBundle/Routing/ChillUrlGenerator.php
 create mode 100644 src/Bundle/ChillMainBundle/Routing/ChillUrlGeneratorInterface.php

diff --git a/src/Bundle/ChillMainBundle/Routing/ChillUrlGenerator.php b/src/Bundle/ChillMainBundle/Routing/ChillUrlGenerator.php
new file mode 100644
index 000000000..eaecee628
--- /dev/null
+++ b/src/Bundle/ChillMainBundle/Routing/ChillUrlGenerator.php
@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Routing;
+
+use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+final readonly class ChillUrlGenerator implements ChillUrlGeneratorInterface
+{
+    public function __construct(private UrlGeneratorInterface $urlGenerator, private RequestStack $requestStack) {}
+
+    public function generate(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
+    {
+        return $this->urlGenerator->generate($name, $parameters, $referenceType);
+    }
+
+    public function generateWithReturnPath(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
+    {
+        $uri = $this->requestStack->getCurrentRequest()->getRequestUri();
+
+        return $this->urlGenerator->generate($name, [$parameters, 'returnPath' => $uri], $referenceType);
+    }
+
+    public function returnPathOr(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
+    {
+        $request = $this->requestStack->getCurrentRequest();
+
+        if ($request->query->has('returnPath')) {
+            return $request->query->get('returnPath');
+        }
+
+        return $this->urlGenerator->generate($name, $parameters, $referenceType);
+    }
+}
diff --git a/src/Bundle/ChillMainBundle/Routing/ChillUrlGeneratorInterface.php b/src/Bundle/ChillMainBundle/Routing/ChillUrlGeneratorInterface.php
new file mode 100644
index 000000000..5c00fa665
--- /dev/null
+++ b/src/Bundle/ChillMainBundle/Routing/ChillUrlGeneratorInterface.php
@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Chill is a software for social workers
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace Chill\MainBundle\Routing;
+
+use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
+
+/**
+ * Interface for generating URLs with returnPath information.
+ */
+interface ChillUrlGeneratorInterface
+{
+    /**
+     * Generate an URL without any return path. This is the same as using @see{UrlGeneratorInterface::generate}.
+     */
+    public function generate(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string;
+
+    /**
+     * Generate an url, append a return path in it.
+     */
+    public function generateWithReturnPath(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string;
+
+    /**
+     * Get the return path or, if any, generate an url.
+     */
+    public function returnPathOr(string $name, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string;
+}
diff --git a/src/Bundle/ChillMainBundle/config/services/routing.yaml b/src/Bundle/ChillMainBundle/config/services/routing.yaml
index 90ce6066f..7d5a80358 100644
--- a/src/Bundle/ChillMainBundle/config/services/routing.yaml
+++ b/src/Bundle/ChillMainBundle/config/services/routing.yaml
@@ -22,3 +22,8 @@ services:
         class: Chill\MainBundle\Routing\MenuTwig
         tags:
             - { name: twig.extension }
+
+    Chill\MainBundle\Routing\ChillUrlGenerator: ~
+
+    Chill\MainBundle\Routing\ChillUrlGeneratorInterface:
+        alias: 'Chill\MainBundle\Routing\ChillUrlGenerator'