Add sites hook to Sitemap class (#438)

Author: duncanmcclean

src/Http/Controllers/SitemapController.php

@@ -5,10 +5,7 @@
 use Carbon\Carbon;
 use Illuminate\Routing\Controller;
 use Illuminate\Support\Facades\Cache;
-use Illuminate\Support\Str;
-use Statamic\Facades;
 use Statamic\SeoPro\Sitemap\Sitemap;
-use Statamic\Sites\Site;
 
 class SitemapController extends Controller
 {
@@ -18,20 +15,19 @@ public function index()
 
         $key = request()->getHttpHost();
         $cacheUntil = Carbon::now()->addMinutes(config('statamic.seo-pro.sitemap.expire'));
-        $sites = Facades\Site::all()->filter(fn (Site $site) => Str::of($site->absoluteUrl())->startsWith(request()->schemeAndHttpHost()));
 
         if (config('statamic.seo-pro.sitemap.pagination.enabled', false)) {
-            $content = Cache::remember(Sitemap::CACHE_KEY.'_'.$key.'_index', $cacheUntil, function () use ($sites) {
+            $content = Cache::remember(Sitemap::CACHE_KEY.'_'.$key.'_index', $cacheUntil, function () {
                 return view('seo-pro::sitemap_index', [
                     'xml_header' => '<?xml version="1.0" encoding="UTF-8"?>',
-                    'sitemaps' => app(Sitemap::class)->forSites($sites)->paginatedSitemaps(),
+                    'sitemaps' => app(Sitemap::class)->paginatedSitemaps(),
                 ])->render();
             });
         } else {
-            $content = Cache::remember(Sitemap::CACHE_KEY.'_'.$key, $cacheUntil, function () use ($sites) {
+            $content = Cache::remember(Sitemap::CACHE_KEY.'_'.$key, $cacheUntil, function () {
                 return view('seo-pro::sitemap', [
                     'xml_header' => '<?xml version="1.0" encoding="UTF-8"?>',
-                    'pages' => app(Sitemap::class)->forSites($sites)->pages(),
+                    'pages' => app(Sitemap::class)->pages(),
                 ])->render();
             });
         }

src/Sitemap/Sitemap.php

@@ -4,6 +4,7 @@
 
 use Illuminate\Support\Collection as IlluminateCollection;
 use Illuminate\Support\LazyCollection;
+use Illuminate\Support\Str;
 use Statamic\Contracts\Entries\Entry;
 use Statamic\Contracts\Query\Builder;
 use Statamic\Contracts\Taxonomies\Term;
@@ -24,13 +25,6 @@ class Sitemap
 
     const CACHE_KEY = 'seo-pro.sitemap';
 
-    private IlluminateCollection $sites;
-
-    public function __construct()
-    {
-        $this->sites = collect();
-    }
-
     public function pages(): array
     {
         return collect()
@@ -103,11 +97,11 @@ public function paginatedSitemaps(): array
             ->all();
     }
 
-    public function forSites(IlluminateCollection $sites): self
+    private function sites(): IlluminateCollection
     {
-        $this->sites = $sites;
+        $sites = SiteFacade::all()->filter(fn ($site) => Str::of($site->absoluteUrl())->startsWith(request()->schemeAndHttpHost()));
 
-        return $this;
+        return $this->runHooks('sites', $sites);
     }
 
     protected function getPages($items)
@@ -153,8 +147,8 @@ protected function publishedEntriesQuery()
 
         return EntryFacade::query()
             ->when(
-                $this->sites->isNotEmpty(),
-                fn (Builder $query) => $query->whereIn('site', $this->sites->map->handle()->all())
+                $this->sites()->isNotEmpty(),
+                fn (Builder $query) => $query->whereIn('site', $this->sites()->map->handle()->all())
             )
             ->whereIn('collection', $collections)
             ->whereNotNull('uri')
@@ -190,7 +184,7 @@ protected function publishedTerms()
                 return $taxonomy->cascade('seo') !== false
                     ? $taxonomy
                         ->queryTerms()
-                        ->when($this->sites->isNotEmpty(), fn (Builder $query) => $query->whereIn('site', $this->sites->map->handle()->all()))
+                        ->when($this->sites()->isNotEmpty(), fn (Builder $query) => $query->whereIn('site', $this->sites()->map->handle()->all()))
                         ->get()
                     : collect();
             })
@@ -213,7 +207,7 @@ protected function publishedCollectionTerms()
                 return $taxonomy->cascade('seo') !== false
                     ? $taxonomy
                         ->queryTerms()
-                        ->when($this->sites->isNotEmpty(), fn (Builder $query) => $query->whereIn('site', $this->sites->map->handle()->all()))
+                        ->when($this->sites()->isNotEmpty(), fn (Builder $query) => $query->whereIn('site', $this->sites()->map->handle()->all()))
                         ->get()->map->collection($taxonomy->collection())
                     : collect();
             })