Add seo tag pages to sitemap generator

Author: sten

README.md

@@ -449,8 +449,6 @@ release:
 - policies:
   - note: undeletable pages
 - undeletable page toggle only for permission holder
-- tag controller
-  - add tag urls to sitemap.
 - documentation
 - Kristof: screenshots + banner + packagist + slack + filament plugin store
 

src/FilamentFlexibleContentBlockPages.php

@@ -42,8 +42,8 @@ public function settings(): Settings
     /**
      * Looks up the resource class of a model in ANY panel.
      *
-     * @param  string<class-string>  $modelClass
-     * @return string<class-string>|null
+     * @param  class-string  $modelClass
+     * @return class-string|null
      */
     public function getModelResource(string $modelClass): ?string
     {

src/Http/Controllers/SeoTagController.php

@@ -118,7 +118,7 @@ private function createModelLabelsLookup(): array
 
         foreach ($enabledModels as $modelClass) {
             $resourceClass = FilamentFlexibleContentBlockPages::getModelResource($modelClass);
-            /** @var resource|null $resourceClass */
+            /** @var class-string|null $resourceClass */
             $labels[$modelClass] = $resourceClass ? $resourceClass::getModelLabel() : class_basename($modelClass);
         }
 

src/Http/Middleware/RedirectsMissingPages.php

@@ -19,10 +19,10 @@ public function handle(Request $request, Closure $next)
         /** @var Response $response */
         $response = parent::handle($request, $next);
 
-        if ($request->query->count() > 0 && $this->shouldRedirect($response)) {
+        if ($request->query->count() > 0 && $this->shouldRedirect($response) && method_exists($response, 'getTargetUrl')) {
             // make sure we do not lose the query string:
             /** @var RedirectResponse $response */
-            if (method_exists($response, 'getTargetUrl') && ! Str::contains($response->getTargetUrl(), '?')) {
+            if (! Str::contains($response->getTargetUrl(), '?')) {
                 $response->setTargetUrl($response->getTargetUrl().'?'.$request->getQueryString());
             }
         }

src/Models/Tag.php

@@ -7,6 +7,7 @@
 use Mcamara\LaravelLocalization\Facades\LaravelLocalization;
 use Mcamara\LaravelLocalization\Interfaces\LocalizedUrlRoutable;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
+use Statikbe\FilamentFlexibleContentBlockPages\Routes\Contracts\HandlesPageRoutes;
 use Statikbe\FilamentFlexibleContentBlocks\Models\Contracts\Linkable;
 
 /**
@@ -67,14 +68,14 @@ public function getViewUrl(?string $locale = null): string
     {
         $locale = $locale ?? app()->getLocale();
 
-        // TODO impl routing & controller
-        // return LaravelLocalization::getURLFromRouteNameTranslated($locale, 'routes.article_tag_index', ['tag:slug' => $this->translate('slug', $locale)]);
-        return 'https://www.statik.be';
+        return route(HandlesPageRoutes::ROUTE_SEO_TAG_PAGE, [
+            'tag:slug' => $this->getTranslation('slug', $locale) ?? $this->slug,
+        ]);
     }
 
     public function getPreviewUrl(?string $locale = null): string
     {
-        return $this->getPreviewUrl($locale);
+        return $this->getViewUrl($locale);
     }
 
     public function getMorphClass()

src/Routes/AbstractPageRouteHelper.php

@@ -10,16 +10,6 @@
 
 abstract class AbstractPageRouteHelper implements HandlesPageRoutes
 {
-    const ROUTE_HOME = 'home';
-
-    const ROUTE_PAGE = 'filament-flexible-content-block-pages::page_index';
-
-    const ROUTE_CHILD_PAGE = 'filament-flexible-content-block-pages::child_page_index';
-
-    const ROUTE_GRANDCHILD_PAGE = 'filament-flexible-content-block-pages::grandchild_page_index';
-
-    const ROUTE_SEO_TAG_PAGE = 'filament-flexible-content-block-pages::seo_tag_page_index';
-
     public function defineRoutes(): void
     {
         if (FilamentFlexibleContentBlockPages::config()->areTagPagesEnabled()) {

src/Routes/Contracts/HandlesPageRoutes.php

@@ -7,6 +7,16 @@
 
 interface HandlesPageRoutes
 {
+    public const ROUTE_PAGE = 'filament-flexible-content-block-pages::page_index';
+
+    public const ROUTE_CHILD_PAGE = 'filament-flexible-content-block-pages::child_page_index';
+
+    public const ROUTE_SEO_TAG_PAGE = 'filament-flexible-content-block-pages::seo_tag_page_index';
+
+    public const ROUTE_HOME = 'home';
+
+    public const ROUTE_GRANDCHILD_PAGE = 'filament-flexible-content-block-pages::grandchild_page_index';
+
     /**
      * Creates the page and SEO tag routes.
      */

src/Services/SitemapGeneratorService.php

@@ -12,6 +12,7 @@
 use Spatie\Sitemap\Tags\Url;
 use Statikbe\FilamentFlexibleContentBlockPages\Facades\FilamentFlexibleContentBlockPages;
 use Statikbe\FilamentFlexibleContentBlockPages\Models\Page;
+use Statikbe\FilamentFlexibleContentBlockPages\Models\Tag;
 use Statikbe\FilamentFlexibleContentBlockPages\Services\Contracts\GeneratesSitemap;
 use Statikbe\FilamentFlexibleContentBlockPages\Services\Enum\SitemapGeneratorMethod;
 use Statikbe\FilamentFlexibleContentBlocks\ContentBlocks\CallToActionBlock;
@@ -69,6 +70,10 @@ protected function generateManually(): void
             $this->addLinkableModels();
         }
 
+        if (FilamentFlexibleContentBlockPages::config()->areTagPagesEnabled()) {
+            $this->addSeoTagPages();
+        }
+
         $this->addCustomUrls();
     }
 
@@ -185,6 +190,22 @@ protected function addCustomUrls(): void
         }
     }
 
+    protected function addSeoTagPages(): void
+    {
+        $seoTags = Tag::whereRelation('tagType', 'has_seo_pages', true)->get();
+
+        foreach ($seoTags as $tag) {
+            $this->sitemap->add(
+                Url::create($tag->getViewUrl($this->canonicalLocale))
+            );
+
+            $this->addToSitemap($tag->getViewUrl($this->canonicalLocale),
+                null, // TODO query the last updated_at of all models.
+                0.6,
+                Url::CHANGE_FREQUENCY_WEEKLY);
+        }
+    }
+
     protected function getLinkableModels(): array
     {
         $ctaModels = FilamentFlexibleBlocksConfig::getCallToActionModels(CallToActionBlock::class);