Update path identification and Fortify integration-related logic (#13)

* Add commented UrlBinding + FortifyRouteTenancy bootstrappers to the config * Improve FortifyRoute bootstrapper docblock * Rename bootstrappers * Complete renaming * Pass defaults of the original URL generator to the new one * Fix URL generator-related test (query string id test WIP) * Fix code style (php-cs-fixer) * Make Fortify bootstrapper not depend on the UrlGenerator bootstrapper, update comments * Fix testing UrlGenerator bootstrapper * Update TenancyUrlGenerator annotations * Pass tenant parameter manually in Fortify bootstrapper * Properly test TenancyUrlGenerator functionality * Get rid of query string in Fortify bootstrapper * Fix code style (php-cs-fixer) * Delete outdated comment * Improve comment * Improve before/afterEach * Encourage passing parameters using TenancyUrlGenerator instead of URL::defaults() * Delete rest of defaulting logic * Fix code style (php-cs-fixer) * Delete test group * Update ForgetTenantParameter docblock * Update passTenantParameterToRoutes annotation * Complete todo in test * Improve test * Update comment * Improve comment * Add keepQueryParameters bool to Fortify bootstrapper * Test keepQueryParameters * minor docblock update * minor docblock changes * Delete extra import * Update src/Overrides/TenancyUrlGenerator.php Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com> * Improve comment * Rename test * Update bypass parameter-related test comments * Fix merge * Rename $keepQueryParameters * Add docblock * Add comment * Refactor Fortify bootstrapper * Fix code style (php-cs-fixer) * Fix comment * Skip Fortify bootstrapper test * minor code improvements * Improve fortify bootstrapper test * Add Fortify bootstrapper annotation, improve code * Fix code style (php-cs-fixer) * Add commenet * Complete resource syncing todo (cleanup not needed) * Delete incorrect namespace * Complete route context trait name todo * Fix code style (php-cs-fixer) --------- Co-authored-by: PHP CS Fixer <phpcsfixer@example.com> Co-authored-by: Samuel Štancl <samuel.stancl@gmail.com>
2025-12-15 06:44:03 +00:00 · 2023-11-26 21:08:41 +01:00 · 2023-11-26 21:08:41 +01:00 · 4953c69fd8
commit 4953c69fd8
parent c043661318
16 changed files with 255 additions and 141 deletions
--- a/src/Bootstrappers/UrlGeneratorBootstrapper.php
+++ b/src/Bootstrappers/UrlGeneratorBootstrapper.php
@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Bootstrappers;
+
+use Illuminate\Contracts\Foundation\Application;
+use Illuminate\Routing\UrlGenerator;
+use Illuminate\Support\Facades\URL;
+use Stancl\Tenancy\Contracts\TenancyBootstrapper;
+use Stancl\Tenancy\Contracts\Tenant;
+use Stancl\Tenancy\Overrides\TenancyUrlGenerator;
+
+/**
+ * Makes the app use TenancyUrlGenerator (instead of Illuminate\Routing\UrlGenerator) which:
+ * - prefixes route names with the tenant route name prefix (PathTenantResolver::tenantRouteNamePrefix() by default)
+ * - passes the tenant parameter to the link generated by route() and temporarySignedRoute() (PathTenantResolver::tenantParameterName() by default).
+ *
+ * Used with path and query string identification.
+ *
+ * @see TenancyUrlGenerator
+ * @see \Stancl\Tenancy\Resolvers\PathTenantResolver
+ */
+class UrlGeneratorBootstrapper implements TenancyBootstrapper
+{
+    public function __construct(
+        protected Application $app,
+        protected UrlGenerator $originalUrlGenerator,
+    ) {
+    }
+
+    public function bootstrap(Tenant $tenant): void
+    {
+        URL::clearResolvedInstances();
+
+        $this->useTenancyUrlGenerator();
+    }
+
+    public function revert(): void
+    {
+        $this->app->bind('url', fn () => $this->originalUrlGenerator);
+    }
+
+    /**
+     * Make 'url' resolve to an instance of TenancyUrlGenerator.
+     *
+     * @see \Illuminate\Routing\RoutingServiceProvider registerUrlGenerator()
+     */
+    protected function useTenancyUrlGenerator(): void
+    {
+        $this->app->extend('url', function (UrlGenerator $urlGenerator, Application $app) {
+            $newGenerator = new TenancyUrlGenerator(
+                $app['router']->getRoutes(),
+                $urlGenerator->getRequest(),
+                $app['config']->get('app.asset_url'),
+            );
+
+            $newGenerator->defaults($urlGenerator->getDefaultParameters());
+
+            $newGenerator->setSessionResolver(function () {
+                return $this->app['session'] ?? null;
+            });
+
+            $newGenerator->setKeyResolver(function () {
+                return $this->app->make('config')->get('app.key');
+            });
+
+            return $newGenerator;
+        });
+    }
+}